GI.Gtk.Objects.CellRendererProgress

CellRendererProgress renders a numeric value as a progress par in a cell. Additionally, it can display a text on top of the progress bar.

The CellRendererProgress cell renderer was added in GTK+ 2.6.

Exported types

newtype CellRendererProgress

Memory-managed wrapper type.

Constructors

CellRendererProgress (ManagedPtr CellRendererProgress)

Instances

Eq CellRendererProgress

Defined in GI.Gtk.Objects.CellRendererProgress

Methods

(==) :: CellRendererProgress -> CellRendererProgress -> Bool

(/=) :: CellRendererProgress -> CellRendererProgress -> Bool

IsGValue CellRendererProgress

Convert CellRendererProgress to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.CellRendererProgress

Methods

toGValue :: CellRendererProgress -> IO GValue

fromGValue :: GValue -> IO CellRendererProgress

GObject CellRendererProgress

Defined in GI.Gtk.Objects.CellRendererProgress

Methods

gobjectType :: IO GType

HasParentTypes CellRendererProgress

Defined in GI.Gtk.Objects.CellRendererProgress

type ParentTypes CellRendererProgress

Defined in GI.Gtk.Objects.CellRendererProgress

type ParentTypes CellRendererProgress = '[CellRenderer, Object, Orientable]

class (GObject o, IsDescendantOf CellRendererProgress o) => IsCellRendererProgress o

Type class for types which can be safely cast to CellRendererProgress, for instance with toCellRendererProgress.

Instances

(GObject o, IsDescendantOf CellRendererProgress o) => IsCellRendererProgress o

Defined in GI.Gtk.Objects.CellRendererProgress

toCellRendererProgress :: (MonadIO m, IsCellRendererProgress o) => o -> m CellRendererProgress

Cast to CellRendererProgress, for types for which this is known to be safe. For general casts, use castTo.

noCellRendererProgress :: Maybe CellRendererProgress

A convenience alias for Nothing :: Maybe CellRendererProgress.

Methods

Overloaded methods

new

cellRendererProgressNew

Arguments

:: (HasCallStack, MonadIO m)

=> m CellRendererProgress

Returns: the new cell renderer

Creates a new CellRendererProgress.

Since: 2.6

Properties

inverted

No description available in the introspection data.

constructCellRendererProgressInverted :: IsCellRendererProgress o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “inverted” property. This is rarely needed directly, but it is used by new.

getCellRendererProgressInverted :: (MonadIO m, IsCellRendererProgress o) => o -> m Bool

Get the value of the “inverted” property. When overloading is enabled, this is equivalent to

get cellRendererProgress #inverted

setCellRendererProgressInverted :: (MonadIO m, IsCellRendererProgress o) => o -> Bool -> m ()

Set the value of the “inverted” property. When overloading is enabled, this is equivalent to

set cellRendererProgress [ #inverted := value ]

pulse

Setting this to a non-negative value causes the cell renderer to enter "activity mode", where a block bounces back and forth to indicate that some progress is made, without specifying exactly how much.

Each increment of the property causes the block to move by a little bit.

To indicate that the activity has not started yet, set the property to zero. To indicate completion, set the property to G_MAXINT.

Since: 2.12

constructCellRendererProgressPulse :: IsCellRendererProgress o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “pulse” property. This is rarely needed directly, but it is used by new.

getCellRendererProgressPulse :: (MonadIO m, IsCellRendererProgress o) => o -> m Int32

Get the value of the “pulse” property. When overloading is enabled, this is equivalent to

get cellRendererProgress #pulse

setCellRendererProgressPulse :: (MonadIO m, IsCellRendererProgress o) => o -> Int32 -> m ()

Set the value of the “pulse” property. When overloading is enabled, this is equivalent to

set cellRendererProgress [ #pulse := value ]

text

The "text" property determines the label which will be drawn over the progress bar. Setting this property to Nothing causes the default label to be displayed. Setting this property to an empty string causes no label to be displayed.

Since: 2.6

clearCellRendererProgressText :: (MonadIO m, IsCellRendererProgress o) => o -> m ()

Set the value of the “text” property to Nothing. When overloading is enabled, this is equivalent to

clear #text

constructCellRendererProgressText :: IsCellRendererProgress o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “text” property. This is rarely needed directly, but it is used by new.

getCellRendererProgressText :: (MonadIO m, IsCellRendererProgress o) => o -> m (Maybe Text)

Get the value of the “text” property. When overloading is enabled, this is equivalent to

get cellRendererProgress #text

setCellRendererProgressText :: (MonadIO m, IsCellRendererProgress o) => o -> Text -> m ()

Set the value of the “text” property. When overloading is enabled, this is equivalent to

set cellRendererProgress [ #text := value ]

textXalign

The "text-xalign" property controls the horizontal alignment of the text in the progress bar. Valid values range from 0 (left) to 1 (right). Reserved for RTL layouts.

Since: 2.12

constructCellRendererProgressTextXalign :: IsCellRendererProgress o => Float -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “text-xalign” property. This is rarely needed directly, but it is used by new.

getCellRendererProgressTextXalign :: (MonadIO m, IsCellRendererProgress o) => o -> m Float

Get the value of the “text-xalign” property. When overloading is enabled, this is equivalent to

get cellRendererProgress #textXalign

setCellRendererProgressTextXalign :: (MonadIO m, IsCellRendererProgress o) => o -> Float -> m ()

Set the value of the “text-xalign” property. When overloading is enabled, this is equivalent to

set cellRendererProgress [ #textXalign := value ]

textYalign

The "text-yalign" property controls the vertical alignment of the text in the progress bar. Valid values range from 0 (top) to 1 (bottom).

Since: 2.12

constructCellRendererProgressTextYalign :: IsCellRendererProgress o => Float -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “text-yalign” property. This is rarely needed directly, but it is used by new.

getCellRendererProgressTextYalign :: (MonadIO m, IsCellRendererProgress o) => o -> m Float

Get the value of the “text-yalign” property. When overloading is enabled, this is equivalent to

get cellRendererProgress #textYalign

setCellRendererProgressTextYalign :: (MonadIO m, IsCellRendererProgress o) => o -> Float -> m ()

Set the value of the “text-yalign” property. When overloading is enabled, this is equivalent to

set cellRendererProgress [ #textYalign := value ]

value

The "value" property determines the percentage to which the progress bar will be "filled in".

Since: 2.6

constructCellRendererProgressValue :: IsCellRendererProgress o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “value” property. This is rarely needed directly, but it is used by new.

getCellRendererProgressValue :: (MonadIO m, IsCellRendererProgress o) => o -> m Int32

Get the value of the “value” property. When overloading is enabled, this is equivalent to

get cellRendererProgress #value

setCellRendererProgressValue :: (MonadIO m, IsCellRendererProgress o) => o -> Int32 -> m ()

Set the value of the “value” property. When overloading is enabled, this is equivalent to

set cellRendererProgress [ #value := value ]