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

noWidgetPath :: Maybe WidgetPath Source

Methods

widgetPathAppendForWidget

data WidgetPathAppendForWidgetMethodInfo Source

Instances

((~) * signature (a -> m Int32), MonadIO m, WidgetK a) => MethodInfo * WidgetPathAppendForWidgetMethodInfo WidgetPath signature 

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

widgetPathAppendType

data WidgetPathAppendTypeMethodInfo Source

Instances

((~) * signature (GType -> m Int32), MonadIO m) => MethodInfo * WidgetPathAppendTypeMethodInfo WidgetPath signature 

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

((~) * signature (m WidgetPath), MonadIO m) => MethodInfo * WidgetPathCopyMethodInfo WidgetPath signature 

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

widgetPathFree

data WidgetPathFreeMethodInfo Source

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * WidgetPathFreeMethodInfo WidgetPath signature 

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

widgetPathGetObjectType

data WidgetPathGetObjectTypeMethodInfo Source

Instances

((~) * signature (m GType), MonadIO m) => MethodInfo * WidgetPathGetObjectTypeMethodInfo WidgetPath signature 

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

widgetPathHasParent

data WidgetPathHasParentMethodInfo Source

Instances

((~) * signature (GType -> m Bool), MonadIO m) => MethodInfo * WidgetPathHasParentMethodInfo WidgetPath signature 

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

widgetPathIsType

data WidgetPathIsTypeMethodInfo Source

Instances

((~) * signature (GType -> m Bool), MonadIO m) => MethodInfo * WidgetPathIsTypeMethodInfo WidgetPath signature 

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

widgetPathIterAddClass

data WidgetPathIterAddClassMethodInfo Source

Instances

((~) * signature (Int32 -> Text -> m ()), MonadIO m) => MethodInfo * WidgetPathIterAddClassMethodInfo WidgetPath signature 

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

widgetPathIterAddRegion

data WidgetPathIterAddRegionMethodInfo Source

Instances

((~) * signature (Int32 -> Text -> [RegionFlags] -> m ()), MonadIO m) => MethodInfo * WidgetPathIterAddRegionMethodInfo WidgetPath signature 

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

((~) * signature (Int32 -> m ()), MonadIO m) => MethodInfo * WidgetPathIterClearClassesMethodInfo WidgetPath signature 

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

widgetPathIterClearRegions

data WidgetPathIterClearRegionsMethodInfo Source

Instances

((~) * signature (Int32 -> m ()), MonadIO m) => MethodInfo * WidgetPathIterClearRegionsMethodInfo WidgetPath signature 

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

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

widgetPathIterGetName

data WidgetPathIterGetNameMethodInfo Source

Instances

((~) * signature (Int32 -> m Text), MonadIO m) => MethodInfo * WidgetPathIterGetNameMethodInfo WidgetPath signature 

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

widgetPathIterGetObjectType

data WidgetPathIterGetObjectTypeMethodInfo Source

Instances

((~) * signature (Int32 -> m GType), MonadIO m) => MethodInfo * WidgetPathIterGetObjectTypeMethodInfo WidgetPath signature 

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

((~) * signature (Int32 -> m [StateFlags]), MonadIO m) => MethodInfo * WidgetPathIterGetStateMethodInfo WidgetPath signature 

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

widgetPathIterHasClass

data WidgetPathIterHasClassMethodInfo Source

Instances

((~) * signature (Int32 -> Text -> m Bool), MonadIO m) => MethodInfo * WidgetPathIterHasClassMethodInfo WidgetPath signature 

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

widgetPathIterHasName

data WidgetPathIterHasNameMethodInfo Source

Instances

((~) * signature (Int32 -> Text -> m Bool), MonadIO m) => MethodInfo * WidgetPathIterHasNameMethodInfo WidgetPath signature 

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

widgetPathIterHasQclass

data WidgetPathIterHasQclassMethodInfo Source

Instances

((~) * signature (Int32 -> Word32 -> m Bool), MonadIO m) => MethodInfo * WidgetPathIterHasQclassMethodInfo WidgetPath signature 

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

widgetPathIterHasQname

data WidgetPathIterHasQnameMethodInfo Source

Instances

((~) * signature (Int32 -> Word32 -> m Bool), MonadIO m) => MethodInfo * WidgetPathIterHasQnameMethodInfo WidgetPath signature 

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

widgetPathIterHasQregion

data WidgetPathIterHasQregionMethodInfo Source

Instances

((~) * signature (Int32 -> Word32 -> m (Bool, [RegionFlags])), MonadIO m) => MethodInfo * WidgetPathIterHasQregionMethodInfo WidgetPath signature 

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

((~) * signature (Int32 -> Text -> m (Bool, [RegionFlags])), MonadIO m) => MethodInfo * WidgetPathIterHasRegionMethodInfo WidgetPath signature 

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

((~) * signature (Int32 -> m [Text]), MonadIO m) => MethodInfo * WidgetPathIterListClassesMethodInfo WidgetPath signature 

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

widgetPathIterListRegions

data WidgetPathIterListRegionsMethodInfo Source

Instances

((~) * signature (Int32 -> m [Text]), MonadIO m) => MethodInfo * WidgetPathIterListRegionsMethodInfo WidgetPath signature 

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

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

widgetPathIterRemoveClass

data WidgetPathIterRemoveClassMethodInfo Source

Instances

((~) * signature (Int32 -> Text -> m ()), MonadIO m) => MethodInfo * WidgetPathIterRemoveClassMethodInfo WidgetPath signature 

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

widgetPathIterRemoveRegion

data WidgetPathIterRemoveRegionMethodInfo Source

Instances

((~) * signature (Int32 -> Text -> m ()), MonadIO m) => MethodInfo * WidgetPathIterRemoveRegionMethodInfo WidgetPath signature 

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

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

widgetPathIterSetName

data WidgetPathIterSetNameMethodInfo Source

Instances

((~) * signature (Int32 -> Text -> m ()), MonadIO m) => MethodInfo * WidgetPathIterSetNameMethodInfo WidgetPath signature 

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

widgetPathIterSetObjectType

data WidgetPathIterSetObjectTypeMethodInfo Source

Instances

((~) * signature (Int32 -> GType -> m ()), MonadIO m) => MethodInfo * WidgetPathIterSetObjectTypeMethodInfo WidgetPath signature 

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

widgetPathIterSetState

data WidgetPathIterSetStateMethodInfo Source

Instances

((~) * signature (Int32 -> [StateFlags] -> m ()), MonadIO m) => MethodInfo * WidgetPathIterSetStateMethodInfo WidgetPath signature 

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

widgetPathLength

data WidgetPathLengthMethodInfo Source

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * WidgetPathLengthMethodInfo WidgetPath signature 

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

widgetPathNew

widgetPathNew :: MonadIO m => m WidgetPath Source

widgetPathPrependType

data WidgetPathPrependTypeMethodInfo Source

Instances

((~) * signature (GType -> m ()), MonadIO m) => MethodInfo * WidgetPathPrependTypeMethodInfo WidgetPath signature 

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

widgetPathRef

data WidgetPathRefMethodInfo Source

Instances

((~) * signature (m WidgetPath), MonadIO m) => MethodInfo * WidgetPathRefMethodInfo WidgetPath signature 

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

widgetPathToString

data WidgetPathToStringMethodInfo Source

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * WidgetPathToStringMethodInfo WidgetPath signature 

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

widgetPathUnref

data WidgetPathUnrefMethodInfo Source

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * WidgetPathUnrefMethodInfo WidgetPath signature 

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