GI.Gtk.Structs.WidgetPath

GtkWidgetPath is a boxed type that represents a widget hierarchy from the topmost widget, typically a toplevel, to any child. This widget path abstraction is used in #GtkStyleContext on behalf of the real widget in order to query style information.

If you are using GTK+ widgets, you probably will not need to use this API directly, as there is gtk_widget_get_path(), and the style context returned by gtk_widget_get_style_context() will be automatically updated on widget hierarchy changes.

The widget path generation is generally simple:

## Defining a button within a window

|[language="C" -- { GtkWidgetPath *path;

path = gtk_widget_path_new (); gtk_widget_path_append_type (path, GTK_TYPE_WINDOW); gtk_widget_path_append_type (path, GTK_TYPE_BUTTON); } ]|

Although more complex information, such as widget names, or different classes (property that may be used by other widget types) and intermediate regions may be included:

## Defining the first tab widget in a notebook

|[language="C" -- { GtkWidgetPath *path; guint pos;

path = gtk_widget_path_new ();

pos = gtk_widget_path_append_type (path, GTK_TYPE_NOTEBOOK); gtk_widget_path_iter_add_region (path, pos, "tab", GTK_REGION_EVEN | GTK_REGION_FIRST);

pos = gtk_widget_path_append_type (path, GTK_TYPE_LABEL); gtk_widget_path_iter_set_name (path, pos, "first tab label"); } ]|

All this information will be used to match the style information that applies to the described widget.

Exported types

newtype WidgetPath

Constructors

WidgetPath (ForeignPtr WidgetPath)

Instances

BoxedObject WidgetPath

noWidgetPath :: Maybe WidgetPath

Methods

widgetPathAppendForWidget

widgetPathAppendForWidget :: (MonadIO m, WidgetK a) => WidgetPath -> a -> m Int32

widgetPathAppendType

widgetPathAppendType :: MonadIO m => WidgetPath -> GType -> m Int32

widgetPathAppendWithSiblings

widgetPathAppendWithSiblings :: MonadIO m => WidgetPath -> WidgetPath -> Word32 -> m Int32

widgetPathCopy

widgetPathCopy :: MonadIO m => WidgetPath -> m WidgetPath

widgetPathFree

widgetPathFree :: MonadIO m => WidgetPath -> m ()

widgetPathGetObjectType

widgetPathGetObjectType :: MonadIO m => WidgetPath -> m GType

widgetPathHasParent

widgetPathHasParent :: MonadIO m => WidgetPath -> GType -> m Bool

widgetPathIsType

widgetPathIsType :: MonadIO m => WidgetPath -> GType -> m Bool

widgetPathIterAddClass

widgetPathIterAddClass :: MonadIO m => WidgetPath -> Int32 -> Text -> m ()

widgetPathIterAddRegion

widgetPathIterAddRegion :: MonadIO m => WidgetPath -> Int32 -> Text -> [RegionFlags] -> m ()

Deprecated: (Since version 3.14)The use of regions is deprecated.

widgetPathIterClearClasses

widgetPathIterClearClasses :: MonadIO m => WidgetPath -> Int32 -> m ()

widgetPathIterClearRegions

widgetPathIterClearRegions :: MonadIO m => WidgetPath -> Int32 -> m ()

Deprecated: (Since version 3.14)The use of regions is deprecated.

widgetPathIterGetName

widgetPathIterGetName :: MonadIO m => WidgetPath -> Int32 -> m Text

widgetPathIterGetObjectType

widgetPathIterGetObjectType :: MonadIO m => WidgetPath -> Int32 -> m GType

widgetPathIterGetSiblingIndex

widgetPathIterGetSiblingIndex :: MonadIO m => WidgetPath -> Int32 -> m Word32

widgetPathIterGetSiblings

widgetPathIterGetSiblings :: MonadIO m => WidgetPath -> Int32 -> m WidgetPath

widgetPathIterGetState

widgetPathIterGetState :: MonadIO m => WidgetPath -> Int32 -> m [StateFlags]

widgetPathIterHasClass

widgetPathIterHasClass :: MonadIO m => WidgetPath -> Int32 -> Text -> m Bool

widgetPathIterHasName

widgetPathIterHasName :: MonadIO m => WidgetPath -> Int32 -> Text -> m Bool

widgetPathIterHasQclass

widgetPathIterHasQclass :: MonadIO m => WidgetPath -> Int32 -> Word32 -> m Bool

widgetPathIterHasQname

widgetPathIterHasQname :: MonadIO m => WidgetPath -> Int32 -> Word32 -> m Bool

widgetPathIterHasQregion

widgetPathIterHasQregion :: MonadIO m => WidgetPath -> Int32 -> Word32 -> m (Bool, [RegionFlags])

Deprecated: (Since version 3.14)The use of regions is deprecated.

widgetPathIterHasRegion

widgetPathIterHasRegion :: MonadIO m => WidgetPath -> Int32 -> Text -> m (Bool, [RegionFlags])

Deprecated: (Since version 3.14)The use of regions is deprecated.

widgetPathIterListClasses

widgetPathIterListClasses :: MonadIO m => WidgetPath -> Int32 -> m [Text]

widgetPathIterListRegions

widgetPathIterListRegions :: MonadIO m => WidgetPath -> Int32 -> m [Text]

Deprecated: (Since version 3.14)The use of regions is deprecated.

widgetPathIterRemoveClass

widgetPathIterRemoveClass :: MonadIO m => WidgetPath -> Int32 -> Text -> m ()

widgetPathIterRemoveRegion

widgetPathIterRemoveRegion :: MonadIO m => WidgetPath -> Int32 -> Text -> m ()

Deprecated: (Since version 3.14)The use of regions is deprecated.

widgetPathIterSetName

widgetPathIterSetName :: MonadIO m => WidgetPath -> Int32 -> Text -> m ()

widgetPathIterSetObjectType

widgetPathIterSetObjectType :: MonadIO m => WidgetPath -> Int32 -> GType -> m ()

widgetPathIterSetState

widgetPathIterSetState :: MonadIO m => WidgetPath -> Int32 -> [StateFlags] -> m ()

widgetPathLength

widgetPathLength :: MonadIO m => WidgetPath -> m Int32

widgetPathNew

widgetPathNew :: MonadIO m => m WidgetPath

widgetPathPrependType

widgetPathPrependType :: MonadIO m => WidgetPath -> GType -> m ()

widgetPathRef

widgetPathRef :: MonadIO m => WidgetPath -> m WidgetPath

widgetPathToString

widgetPathToString :: MonadIO m => WidgetPath -> m Text

widgetPathUnref

widgetPathUnref :: MonadIO m => WidgetPath -> m ()