gi-gtk-0.3.18.13: Gtk bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Structs.WidgetPath

Contents

Description

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.

Synopsis

Exported types

newtype WidgetPath Source

Constructors

WidgetPath (ForeignPtr WidgetPath) 

Instances

BoxedObject WidgetPath Source 
((~) * info (ResolveWidgetPathMethod t WidgetPath), MethodInfo * info WidgetPath p) => IsLabel t (WidgetPath -> p) Source 

Methods

fromLabel :: Proxy# Symbol t -> WidgetPath -> p

((~) * info (ResolveWidgetPathMethod t WidgetPath), MethodInfo * info WidgetPath p) => IsLabelProxy t (WidgetPath -> p) Source 
((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathUnrefMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (m Text), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathToStringMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (m WidgetPath), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathRefMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (GType -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathPrependTypeMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (m Int32), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathLengthMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> [StateFlags] -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterSetStateMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> GType -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterSetObjectTypeMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> Text -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterSetNameMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> Text -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterRemoveRegionMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> Text -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterRemoveClassMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> m [Text]), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterListRegionsMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> m [Text]), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterListClassesMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> Text -> m (Bool, [RegionFlags])), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterHasRegionMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> Word32 -> m (Bool, [RegionFlags])), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterHasQregionMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> Word32 -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterHasQnameMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> Word32 -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterHasQclassMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterHasNameMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterHasClassMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> m [StateFlags]), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterGetStateMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> m WidgetPath), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterGetSiblingsMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> m Word32), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterGetSiblingIndexMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> m GType), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterGetObjectTypeMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> m Text), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterGetNameMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterClearRegionsMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterClearClassesMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> Text -> [RegionFlags] -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterAddRegionMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (Int32 -> Text -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIterAddClassMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (GType -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathIsTypeMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (GType -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathHasParentMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (m GType), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathGetObjectTypeMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathFreeMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (m WidgetPath), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathCopyMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (WidgetPath -> Word32 -> m Int32), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathAppendWithSiblingsMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (GType -> m Int32), MonadIO m) => MethodInfo (TYPE Lifted) WidgetPathAppendTypeMethodInfo WidgetPath signature Source 
((~) (TYPE Lifted) signature (a -> m Int32), MonadIO m, WidgetK a) => MethodInfo (TYPE Lifted) WidgetPathAppendForWidgetMethodInfo WidgetPath signature Source 

noWidgetPath :: Maybe WidgetPath Source

Methods

widgetPathAppendForWidget

data WidgetPathAppendForWidgetMethodInfo Source

Instances

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

widgetPathAppendType

data WidgetPathAppendTypeMethodInfo Source

Instances

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

widgetPathAppendWithSiblings

data WidgetPathAppendWithSiblingsMethodInfo Source

Instances

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

widgetPathCopy

data WidgetPathCopyMethodInfo Source

Instances

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

widgetPathFree

data WidgetPathFreeMethodInfo Source

Instances

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

widgetPathGetObjectType

data WidgetPathGetObjectTypeMethodInfo Source

Instances

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

widgetPathHasParent

data WidgetPathHasParentMethodInfo Source

Instances

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

widgetPathIsType

data WidgetPathIsTypeMethodInfo Source

Instances

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

widgetPathIterAddClass

data WidgetPathIterAddClassMethodInfo Source

Instances

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

widgetPathIterAddRegion

data WidgetPathIterAddRegionMethodInfo Source

Instances

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

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

widgetPathIterClearClasses

data WidgetPathIterClearClassesMethodInfo Source

Instances

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

widgetPathIterClearRegions

data WidgetPathIterClearRegionsMethodInfo Source

Instances

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

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

widgetPathIterGetName

data WidgetPathIterGetNameMethodInfo Source

Instances

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

widgetPathIterGetObjectType

data WidgetPathIterGetObjectTypeMethodInfo Source

Instances

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

widgetPathIterGetSiblingIndex

data WidgetPathIterGetSiblingIndexMethodInfo Source

Instances

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

widgetPathIterGetSiblings

data WidgetPathIterGetSiblingsMethodInfo Source

Instances

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

widgetPathIterGetState

data WidgetPathIterGetStateMethodInfo Source

Instances

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

widgetPathIterHasClass

data WidgetPathIterHasClassMethodInfo Source

Instances

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

widgetPathIterHasName

data WidgetPathIterHasNameMethodInfo Source

Instances

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

widgetPathIterHasQclass

data WidgetPathIterHasQclassMethodInfo Source

Instances

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

widgetPathIterHasQname

data WidgetPathIterHasQnameMethodInfo Source

Instances

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

widgetPathIterHasQregion

data WidgetPathIterHasQregionMethodInfo Source

Instances

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

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

widgetPathIterHasRegion

data WidgetPathIterHasRegionMethodInfo Source

Instances

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

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

widgetPathIterListClasses

data WidgetPathIterListClassesMethodInfo Source

Instances

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

widgetPathIterListRegions

data WidgetPathIterListRegionsMethodInfo Source

Instances

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

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

widgetPathIterRemoveClass

data WidgetPathIterRemoveClassMethodInfo Source

Instances

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

widgetPathIterRemoveRegion

data WidgetPathIterRemoveRegionMethodInfo Source

Instances

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

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

widgetPathIterSetName

data WidgetPathIterSetNameMethodInfo Source

Instances

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

widgetPathIterSetObjectType

data WidgetPathIterSetObjectTypeMethodInfo Source

Instances

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

widgetPathIterSetState

data WidgetPathIterSetStateMethodInfo Source

Instances

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

widgetPathLength

data WidgetPathLengthMethodInfo Source

Instances

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

widgetPathNew

widgetPathNew :: MonadIO m => m WidgetPath Source

widgetPathPrependType

data WidgetPathPrependTypeMethodInfo Source

Instances

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

widgetPathRef

data WidgetPathRefMethodInfo Source

Instances

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

widgetPathToString

data WidgetPathToStringMethodInfo Source

Instances

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

widgetPathUnref

data WidgetPathUnrefMethodInfo Source

Instances

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