gi-gtk-3.0.24: 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.Interfaces.Buildable

Contents

Description

GtkBuildable allows objects to extend and customize their deserialization from [GtkBuilder UI descriptions][BUILDER-UI]. The interface includes methods for setting names and properties of objects, parsing custom tags and constructing child objects.

The GtkBuildable interface is implemented by all widgets and many of the non-widget objects that are provided by GTK+. The main user of this interface is Builder. There should be very little need for applications to call any of these functions directly.

An object only needs to implement this interface if it needs to extend the Builder format or run any extra routines at deserialization time.

Synopsis

Exported types

newtype Buildable Source #

Memory-managed wrapper type.

Constructors

Buildable (ManagedPtr Buildable) 

Instances

GObject Buildable Source # 

Methods

gobjectType :: Buildable -> IO GType

IsBuildable Buildable Source # 
IsObject Buildable Source # 

noBuildable :: Maybe Buildable Source #

A convenience alias for Nothing :: Maybe Buildable.

class GObject o => IsBuildable o Source #

Type class for types which can be safely cast to Buildable, for instance with toBuildable.

Instances

(GObject a, UnknownAncestorError Constraint Buildable a) => IsBuildable a Source # 
IsBuildable Buildable Source # 
IsBuildable Action Source # 
IsBuildable ActionGroup Source # 
IsBuildable Bin Source # 
IsBuildable Box Source # 
IsBuildable Button Source # 
IsBuildable ButtonBox Source # 
IsBuildable Calendar Source # 
IsBuildable CellArea Source # 
IsBuildable CellAreaBox Source # 
IsBuildable CheckButton Source # 
IsBuildable CheckMenuItem Source # 
IsBuildable ComboBox Source # 
IsBuildable Container Source # 
IsBuildable Dialog Source # 
IsBuildable Entry Source # 
IsBuildable EntryCompletion Source # 
IsBuildable FileFilter Source # 
IsBuildable FlowBox Source # 
IsBuildable FlowBoxChild Source # 
IsBuildable Frame Source # 
IsBuildable IconFactory Source # 
IsBuildable IconView Source # 
IsBuildable Label Source # 
IsBuildable ListBox Source # 
IsBuildable ListBoxRow Source # 
IsBuildable Menu Source # 
IsBuildable MenuItem Source # 
IsBuildable MenuShell Source # 
IsBuildable Misc Source # 
IsBuildable Paned Source # 
IsBuildable Popover Source # 
IsBuildable RadioButton Source # 
IsBuildable Range Source # 
IsBuildable RecentFilter Source # 
IsBuildable RecentAction Source # 
IsBuildable Scale Source # 
IsBuildable ScaleButton Source # 
IsBuildable Scrollbar Source # 
IsBuildable ScrolledWindow Source # 
IsBuildable Separator Source # 
IsBuildable ShortcutsWindow Source # 
IsBuildable SizeGroup Source # 
IsBuildable SpinButton Source # 
IsBuildable Stack Source # 
IsBuildable TextTagTable Source # 
IsBuildable ToggleAction Source # 
IsBuildable RadioAction Source # 
IsBuildable ToggleButton Source # 
IsBuildable ToggleToolButton Source # 
IsBuildable ToolButton Source # 
IsBuildable ToolItem Source # 
IsBuildable ToolItemGroup Source # 
IsBuildable TreeView Source # 
IsBuildable TreeViewColumn Source # 
IsBuildable Widget Source # 
IsBuildable VolumeButton Source # 
IsBuildable Viewport Source # 
IsBuildable VSeparator Source # 
IsBuildable VScrollbar Source # 
IsBuildable VScale Source # 
IsBuildable VPaned Source # 
IsBuildable VButtonBox Source # 
IsBuildable VBox Source # 
IsBuildable UIManager Source # 
IsBuildable Toolbar Source # 
IsBuildable TearoffMenuItem Source # 
IsBuildable Table Source # 
IsBuildable Switch Source # 
IsBuildable Statusbar Source # 
IsBuildable StackSwitcher Source # 
IsBuildable StackSidebar Source # 
IsBuildable Spinner Source # 
IsBuildable Socket Source # 
IsBuildable ShortcutsShortcut Source # 
IsBuildable ShortcutsSection Source # 
IsBuildable ShortcutsGroup Source # 
IsBuildable ShortcutLabel Source # 
IsBuildable SeparatorToolItem Source # 
IsBuildable SeparatorMenuItem Source # 
IsBuildable SearchEntry Source # 
IsBuildable SearchBar Source # 
IsBuildable Revealer Source # 
IsBuildable RecentChooserWidget Source # 
IsBuildable RecentChooserMenu Source # 
IsBuildable RadioToolButton Source # 
IsBuildable RadioMenuItem Source # 
IsBuildable ProgressBar Source # 
IsBuildable PopoverMenu Source # 
IsBuildable PlacesSidebar Source # 
IsBuildable Overlay Source # 
IsBuildable Notebook Source # 
IsBuildable ModelButton Source # 
IsBuildable MenuToolButton Source # 
IsBuildable MenuButton Source # 
IsBuildable MenuBar Source # 
IsBuildable LockButton Source # 
IsBuildable LinkButton Source # 
IsBuildable LevelBar Source # 
IsBuildable Layout Source # 
IsBuildable Invisible Source # 
IsBuildable InfoBar Source # 
IsBuildable ImageMenuItem Source # 
IsBuildable HeaderBar Source # 
IsBuildable HandleBox Source # 
IsBuildable HSeparator Source # 
IsBuildable HScrollbar Source # 
IsBuildable HScale Source # 
IsBuildable HSV Source # 
IsBuildable HPaned Source # 
IsBuildable HButtonBox Source # 
IsBuildable HBox Source # 
IsBuildable Grid Source # 
IsBuildable GLArea Source # 
IsBuildable FontSelection Source # 
IsBuildable FontChooserWidget Source # 
IsBuildable FontButton Source # 
IsBuildable Fixed Source # 
IsBuildable FileChooserWidget Source # 
IsBuildable FileChooserButton Source # 
IsBuildable Expander Source # 
IsBuildable EventBox Source # 
IsBuildable DrawingArea Source # 
IsBuildable ComboBoxText Source # 
IsBuildable ColorSelection Source # 
IsBuildable ColorChooserWidget Source # 
IsBuildable ColorButton Source # 
IsBuildable AspectFrame Source # 
IsBuildable Arrow Source # 
IsBuildable AppChooserWidget Source # 
IsBuildable AppChooserButton Source # 
IsBuildable Alignment Source # 
IsBuildable ActionBar Source # 
IsBuildable AccelLabel Source # 
IsBuildable Window Source # 
IsBuildable RecentChooserDialog Source # 
IsBuildable Plug Source # 
IsBuildable OffscreenWindow Source # 
IsBuildable MessageDialog Source # 
IsBuildable FontSelectionDialog Source # 
IsBuildable FontChooserDialog Source # 
IsBuildable FileChooserDialog Source # 
IsBuildable ColorSelectionDialog Source # 
IsBuildable ColorChooserDialog Source # 
IsBuildable ApplicationWindow Source # 
IsBuildable AppChooserDialog Source # 
IsBuildable AboutDialog Source # 
IsBuildable Image Source # 
IsBuildable ToolPalette Source # 
IsBuildable TextView Source # 
IsBuildable TreeStore Source # 
IsBuildable ListStore Source # 
IsBuildable CellView Source # 
IsBuildable Assistant Source # 

toBuildable :: (MonadIO m, IsBuildable o) => o -> m Buildable Source #

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

Methods

addChild

buildableAddChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuildable a, IsBuilder b, IsObject c) 
=> a

buildable: a Buildable

-> b

builder: a Builder

-> c

child: child to add

-> Maybe Text

type: kind of child or Nothing

-> m () 

Adds a child to buildable. type is an optional string describing how the child should be added.

Since: 2.12

constructChild

buildableConstructChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuildable a, IsBuilder b) 
=> a

buildable: A Buildable

-> b

builder: Builder used to construct this object

-> Text

name: name of child to construct

-> m Object

Returns: the constructed child

Constructs a child of buildable with the name name.

Builder calls this function if a “constructor” has been specified in the UI definition.

Since: 2.12

customFinished

buildableCustomFinished Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuildable a, IsBuilder b, IsObject c) 
=> a

buildable: a Buildable

-> b

builder: a Builder

-> Maybe c

child: child object or Nothing for non-child tags

-> Text

tagname: the name of the tag

-> Ptr ()

data: user data created in custom_tag_start

-> m () 

This is similar to buildableParserFinished but is called once for each custom tag handled by the buildable.

Since: 2.12

customTagEnd

buildableCustomTagEnd Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuildable a, IsBuilder b, IsObject c) 
=> a

buildable: A Buildable

-> b

builder: Builder used to construct this object

-> Maybe c

child: child object or Nothing for non-child tags

-> Text

tagname: name of tag

-> Ptr ()

data: user data that will be passed in to parser functions

-> m () 

This is called at the end of each custom element handled by the buildable.

Since: 2.12

customTagStart

buildableCustomTagStart Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuildable a, IsBuilder b, IsObject c) 
=> a

buildable: a Buildable

-> b

builder: a Builder used to construct this object

-> Maybe c

child: child object or Nothing for non-child tags

-> Text

tagname: name of tag

-> m (Bool, MarkupParser, Ptr ())

Returns: True if a object has a custom implementation, False if it doesn't.

This is called for each unknown element under <child>.

Since: 2.12

getInternalChild

buildableGetInternalChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuildable a, IsBuilder b) 
=> a

buildable: a Buildable

-> b

builder: a Builder

-> Text

childname: name of child

-> m Object

Returns: the internal child of the buildable object

Get the internal child called childname of the buildable object.

Since: 2.12

getName

buildableGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuildable a) 
=> a

buildable: a Buildable

-> m Text

Returns: the name set with buildableSetName

Gets the name of the buildable object.

Builder sets the name based on the [GtkBuilder UI definition][BUILDER-UI] used to construct the buildable.

Since: 2.12

parserFinished

buildableParserFinished Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuildable a, IsBuilder b) 
=> a

buildable: a Buildable

-> b

builder: a Builder

-> m () 

Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time builderAddFromFile or builderAddFromString is called on a builder.

Since: 2.12

setBuildableProperty

buildableSetBuildableProperty Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuildable a, IsBuilder b) 
=> a

buildable: a Buildable

-> b

builder: a Builder

-> Text

name: name of property

-> GValue

value: value of property

-> m () 

Sets the property name name to value on the buildable object.

Since: 2.12

setName

buildableSetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuildable a) 
=> a

buildable: a Buildable

-> Text

name: name to set

-> m () 

Sets the name of the buildable object.

Since: 2.12