gi-gtk-3.0.26: Gtk bindings

Copyright Will Thompson Iñaki García Etxebarria and Jonas Platte LGPL-2.1 Iñaki García Etxebarria (garetxe@gmail.com) None Haskell2010

GI.Gtk.Objects.CellRendererProgress

Description

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.

Synopsis

# Exported types

newtype CellRendererProgress Source #

Memory-managed wrapper type.

Constructors

 CellRendererProgress (ManagedPtr CellRendererProgress)
Instances
 Source # Instance detailsDefined in GI.Gtk.Objects.CellRendererProgress Methods Source # Instance detailsDefined in GI.Gtk.Objects.CellRendererProgress Source # Instance detailsDefined in GI.Gtk.Objects.CellRendererProgress Source # Instance detailsDefined in GI.Gtk.Objects.CellRendererProgress Source # Instance detailsDefined in GI.Gtk.Objects.CellRendererProgress

class GObject o => IsCellRendererProgress o Source #

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

Instances
 Source # Instance detailsDefined in GI.Gtk.Objects.CellRendererProgress Source # Instance detailsDefined in GI.Gtk.Objects.CellRendererProgress

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

A convenience alias for Nothing :: Maybe CellRendererProgress.

# Methods

## new

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.

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 Source #

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 () Source #

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

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 Source #

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 () Source #

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 () Source #

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

clear #text


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) Source #

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 () Source #

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

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

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 () Source #

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

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

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 () Source #

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

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 Source #

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 () Source #

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

set cellRendererProgress [ #value := value ]