GI.Gtk.Interfaces.Buildable

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.

Exported types

newtype Buildable

Constructors

Buildable (ManagedPtr Buildable)

Instances

GObject Buildable

Methods

gobjectType :: Buildable -> IO GType

IsObject Buildable

IsBuildable Buildable

((~) * info (ResolveBuildableMethod t Buildable), MethodInfo * info Buildable p) => IsLabel t (Buildable -> p)

Methods

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

((~) * info (ResolveBuildableMethod t Buildable), MethodInfo * info Buildable p) => IsLabelProxy t (Buildable -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Buildable -> p

HasAttributeList * Buildable

type AttributeList Buildable

type AttributeList Buildable

type SignalList Buildable

type SignalList Buildable

noBuildable :: Maybe Buildable

class GObject o => IsBuildable o

Instances

(GObject a, UnknownAncestorError Constraint Buildable a) => IsBuildable a

IsBuildable Window

IsBuildable Widget

IsBuildable TreeViewColumn

IsBuildable TreeView

IsBuildable ToolItemGroup

IsBuildable ToolItem

IsBuildable ToolButton

IsBuildable ToggleToolButton

IsBuildable ToggleButton

IsBuildable ToggleAction

IsBuildable TextTagTable

IsBuildable Stack

IsBuildable SpinButton

IsBuildable SizeGroup

IsBuildable ShortcutsWindow

IsBuildable Separator

IsBuildable ScrolledWindow

IsBuildable Scrollbar

IsBuildable ScaleButton

IsBuildable Scale

IsBuildable RecentFilter

IsBuildable Range

IsBuildable RadioButton

IsBuildable Popover

IsBuildable Paned

IsBuildable Misc

IsBuildable MenuShell

IsBuildable MenuItem

IsBuildable Menu

IsBuildable ListBoxRow

IsBuildable ListBox

IsBuildable Label

IsBuildable IconView

IsBuildable IconFactory

IsBuildable Frame

IsBuildable FlowBoxChild

IsBuildable FlowBox

IsBuildable FileFilter

IsBuildable EntryCompletion

IsBuildable Entry

IsBuildable Dialog

IsBuildable Container

IsBuildable ComboBox

IsBuildable CheckMenuItem

IsBuildable CheckButton

IsBuildable CellArea

IsBuildable Calendar

IsBuildable ButtonBox

IsBuildable Button

IsBuildable Box

IsBuildable Bin

IsBuildable ActionGroup

IsBuildable Action

IsBuildable Buildable

IsBuildable AccelLabel

IsBuildable ActionBar

IsBuildable Alignment

IsBuildable ApplicationWindow

IsBuildable AspectFrame

IsBuildable CellAreaBox

IsBuildable CellView

IsBuildable ColorChooserDialog

IsBuildable ColorChooserWidget

IsBuildable ColorSelection

IsBuildable ColorSelectionDialog

IsBuildable ComboBoxText

IsBuildable DrawingArea

IsBuildable EventBox

IsBuildable Expander

IsBuildable FileChooserDialog

IsBuildable Fixed

IsBuildable FontChooserDialog

IsBuildable FontChooserWidget

IsBuildable FontSelection

IsBuildable FontSelectionDialog

IsBuildable GLArea

IsBuildable HBox

IsBuildable HButtonBox

IsBuildable HPaned

IsBuildable HScale

IsBuildable HScrollbar

IsBuildable HSeparator

IsBuildable HeaderBar

IsBuildable Invisible

IsBuildable Layout

IsBuildable ListStore

IsBuildable OffscreenWindow

IsBuildable Overlay

IsBuildable Plug

IsBuildable PopoverMenu

IsBuildable ProgressBar

IsBuildable RadioAction

IsBuildable RecentAction

IsBuildable RecentChooserDialog

IsBuildable RecentChooserWidget

IsBuildable SearchBar

IsBuildable SearchEntry

IsBuildable ShortcutLabel

IsBuildable ShortcutsGroup

IsBuildable ShortcutsSection

IsBuildable Socket

IsBuildable Spinner

IsBuildable StackSidebar

IsBuildable StackSwitcher

IsBuildable Statusbar

IsBuildable TreeStore

IsBuildable VBox

IsBuildable VButtonBox

IsBuildable VPaned

IsBuildable VScale

IsBuildable VScrollbar

IsBuildable VSeparator

IsBuildable AppChooserButton

IsBuildable AppChooserWidget

IsBuildable RecentChooserMenu

IsBuildable SeparatorToolItem

IsBuildable ColorButton

IsBuildable FontButton

IsBuildable ImageMenuItem

IsBuildable LinkButton

IsBuildable LockButton

IsBuildable MenuToolButton

IsBuildable RadioMenuItem

IsBuildable RadioToolButton

IsBuildable SeparatorMenuItem

IsBuildable Switch

IsBuildable TearoffMenuItem

IsBuildable VolumeButton

IsBuildable AppChooserDialog

IsBuildable PlacesSidebar

IsBuildable Table

IsBuildable UIManager

IsBuildable AboutDialog

IsBuildable Arrow

IsBuildable FileChooserButton

IsBuildable FileChooserWidget

IsBuildable Grid

IsBuildable HSV

IsBuildable HandleBox

IsBuildable Image

IsBuildable InfoBar

IsBuildable LevelBar

IsBuildable MenuBar

IsBuildable MenuButton

IsBuildable MessageDialog

IsBuildable ModelButton

IsBuildable Notebook

IsBuildable Revealer

IsBuildable ShortcutsShortcut

IsBuildable TextView

IsBuildable ToolPalette

IsBuildable Toolbar

IsBuildable Viewport

IsBuildable Assistant

toBuildable :: IsBuildable o => o -> IO Buildable

Methods

addChild

data BuildableAddChildMethodInfo

Instances

((~) * signature (b -> c -> Maybe Text -> m ()), MonadIO m, IsBuildable a, IsBuilder b, IsObject c) => MethodInfo * BuildableAddChildMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BuildableAddChildMethodInfo a -> signature -> s

buildableAddChild

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

data BuildableConstructChildMethodInfo

Instances

((~) * signature (b -> Text -> m Object), MonadIO m, IsBuildable a, IsBuilder b) => MethodInfo * BuildableConstructChildMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BuildableConstructChildMethodInfo a -> signature -> s

buildableConstructChild

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

data BuildableCustomFinishedMethodInfo

Instances

((~) * signature (b -> Maybe c -> Text -> Ptr () -> m ()), MonadIO m, IsBuildable a, IsBuilder b, IsObject c) => MethodInfo * BuildableCustomFinishedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BuildableCustomFinishedMethodInfo a -> signature -> s

buildableCustomFinished

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

data BuildableCustomTagEndMethodInfo

Instances

((~) * signature (b -> Maybe c -> Text -> Ptr () -> m ()), MonadIO m, IsBuildable a, IsBuilder b, IsObject c) => MethodInfo * BuildableCustomTagEndMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BuildableCustomTagEndMethodInfo a -> signature -> s

buildableCustomTagEnd

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

data BuildableCustomTagStartMethodInfo

Instances

((~) * signature (b -> Maybe c -> Text -> m (Bool, MarkupParser, Ptr ())), MonadIO m, IsBuildable a, IsBuilder b, IsObject c) => MethodInfo * BuildableCustomTagStartMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BuildableCustomTagStartMethodInfo a -> signature -> s

buildableCustomTagStart

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

data BuildableGetInternalChildMethodInfo

Instances

((~) * signature (b -> Text -> m Object), MonadIO m, IsBuildable a, IsBuilder b) => MethodInfo * BuildableGetInternalChildMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BuildableGetInternalChildMethodInfo a -> signature -> s

buildableGetInternalChild

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

data BuildableGetNameMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsBuildable a) => MethodInfo * BuildableGetNameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BuildableGetNameMethodInfo a -> signature -> s

buildableGetName

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

data BuildableParserFinishedMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsBuildable a, IsBuilder b) => MethodInfo * BuildableParserFinishedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BuildableParserFinishedMethodInfo a -> signature -> s

buildableParserFinished

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

data BuildableSetBuildablePropertyMethodInfo

Instances

((~) * signature (b -> Text -> GValue -> m ()), MonadIO m, IsBuildable a, IsBuilder b) => MethodInfo * BuildableSetBuildablePropertyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BuildableSetBuildablePropertyMethodInfo a -> signature -> s

buildableSetBuildableProperty

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

data BuildableSetNameMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsBuildable a) => MethodInfo * BuildableSetNameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BuildableSetNameMethodInfo a -> signature -> s

buildableSetName

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