gi-gtk-3.0.27: 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.

Instances
GObject Buildable Source # 
Instance details

Defined in GI.Gtk.Interfaces.Buildable

IsObject Buildable Source # 
Instance details

Defined in GI.Gtk.Interfaces.Buildable

IsBuildable Buildable Source # 
Instance details

Defined in GI.Gtk.Interfaces.Buildable

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 Buildable a :: Constraint)) => IsBuildable a Source # 
Instance details

Defined in GI.Gtk.Interfaces.Buildable

IsBuildable Buildable Source # 
Instance details

Defined in GI.Gtk.Interfaces.Buildable

IsBuildable Action Source # 
Instance details

Defined in GI.Gtk.Objects.Action

IsBuildable ActionGroup Source # 
Instance details

Defined in GI.Gtk.Objects.ActionGroup

IsBuildable Bin Source # 
Instance details

Defined in GI.Gtk.Objects.Bin

IsBuildable Box Source # 
Instance details

Defined in GI.Gtk.Objects.Box

IsBuildable Button Source # 
Instance details

Defined in GI.Gtk.Objects.Button

IsBuildable ButtonBox Source # 
Instance details

Defined in GI.Gtk.Objects.ButtonBox

IsBuildable Calendar Source # 
Instance details

Defined in GI.Gtk.Objects.Calendar

IsBuildable CellArea Source # 
Instance details

Defined in GI.Gtk.Objects.CellArea

IsBuildable CellAreaBox Source # 
Instance details

Defined in GI.Gtk.Objects.CellAreaBox

IsBuildable CheckButton Source # 
Instance details

Defined in GI.Gtk.Objects.CheckButton

IsBuildable CheckMenuItem Source # 
Instance details

Defined in GI.Gtk.Objects.CheckMenuItem

IsBuildable ComboBox Source # 
Instance details

Defined in GI.Gtk.Objects.ComboBox

IsBuildable Container Source # 
Instance details

Defined in GI.Gtk.Objects.Container

IsBuildable Dialog Source # 
Instance details

Defined in GI.Gtk.Objects.Dialog

IsBuildable Entry Source # 
Instance details

Defined in GI.Gtk.Objects.Entry

IsBuildable EntryCompletion Source # 
Instance details

Defined in GI.Gtk.Objects.EntryCompletion

IsBuildable FileFilter Source # 
Instance details

Defined in GI.Gtk.Objects.FileFilter

IsBuildable FlowBox Source # 
Instance details

Defined in GI.Gtk.Objects.FlowBox

IsBuildable FlowBoxChild Source # 
Instance details

Defined in GI.Gtk.Objects.FlowBoxChild

IsBuildable Frame Source # 
Instance details

Defined in GI.Gtk.Objects.Frame

IsBuildable IconFactory Source # 
Instance details

Defined in GI.Gtk.Objects.IconFactory

IsBuildable IconView Source # 
Instance details

Defined in GI.Gtk.Objects.IconView

IsBuildable Label Source # 
Instance details

Defined in GI.Gtk.Objects.Label

IsBuildable ListBox Source # 
Instance details

Defined in GI.Gtk.Objects.ListBox

IsBuildable ListBoxRow Source # 
Instance details

Defined in GI.Gtk.Objects.ListBoxRow

IsBuildable Menu Source # 
Instance details

Defined in GI.Gtk.Objects.Menu

IsBuildable MenuItem Source # 
Instance details

Defined in GI.Gtk.Objects.MenuItem

IsBuildable MenuShell Source # 
Instance details

Defined in GI.Gtk.Objects.MenuShell

IsBuildable Misc Source # 
Instance details

Defined in GI.Gtk.Objects.Misc

IsBuildable Paned Source # 
Instance details

Defined in GI.Gtk.Objects.Paned

IsBuildable Popover Source # 
Instance details

Defined in GI.Gtk.Objects.Popover

IsBuildable RadioButton Source # 
Instance details

Defined in GI.Gtk.Objects.RadioButton

IsBuildable Range Source # 
Instance details

Defined in GI.Gtk.Objects.Range

IsBuildable RecentFilter Source # 
Instance details

Defined in GI.Gtk.Objects.RecentFilter

IsBuildable RecentAction Source # 
Instance details

Defined in GI.Gtk.Objects.RecentAction

IsBuildable Scale Source # 
Instance details

Defined in GI.Gtk.Objects.Scale

IsBuildable ScaleButton Source # 
Instance details

Defined in GI.Gtk.Objects.ScaleButton

IsBuildable Scrollbar Source # 
Instance details

Defined in GI.Gtk.Objects.Scrollbar

IsBuildable ScrolledWindow Source # 
Instance details

Defined in GI.Gtk.Objects.ScrolledWindow

IsBuildable Separator Source # 
Instance details

Defined in GI.Gtk.Objects.Separator

IsBuildable ShortcutsWindow Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutsWindow

IsBuildable SizeGroup Source # 
Instance details

Defined in GI.Gtk.Objects.SizeGroup

IsBuildable SpinButton Source # 
Instance details

Defined in GI.Gtk.Objects.SpinButton

IsBuildable Stack Source # 
Instance details

Defined in GI.Gtk.Objects.Stack

IsBuildable TextTagTable Source # 
Instance details

Defined in GI.Gtk.Objects.TextTagTable

IsBuildable ToggleAction Source # 
Instance details

Defined in GI.Gtk.Objects.ToggleAction

IsBuildable RadioAction Source # 
Instance details

Defined in GI.Gtk.Objects.RadioAction

IsBuildable ToggleButton Source # 
Instance details

Defined in GI.Gtk.Objects.ToggleButton

IsBuildable ToggleToolButton Source # 
Instance details

Defined in GI.Gtk.Objects.ToggleToolButton

IsBuildable ToolButton Source # 
Instance details

Defined in GI.Gtk.Objects.ToolButton

IsBuildable ToolItem Source # 
Instance details

Defined in GI.Gtk.Objects.ToolItem

IsBuildable ToolItemGroup Source # 
Instance details

Defined in GI.Gtk.Objects.ToolItemGroup

IsBuildable TreeView Source # 
Instance details

Defined in GI.Gtk.Objects.TreeView

IsBuildable TreeViewColumn Source # 
Instance details

Defined in GI.Gtk.Objects.TreeViewColumn

IsBuildable Widget Source # 
Instance details

Defined in GI.Gtk.Objects.Widget

IsBuildable VolumeButton Source # 
Instance details

Defined in GI.Gtk.Objects.VolumeButton

IsBuildable Viewport Source # 
Instance details

Defined in GI.Gtk.Objects.Viewport

IsBuildable VSeparator Source # 
Instance details

Defined in GI.Gtk.Objects.VSeparator

IsBuildable VScrollbar Source # 
Instance details

Defined in GI.Gtk.Objects.VScrollbar

IsBuildable VScale Source # 
Instance details

Defined in GI.Gtk.Objects.VScale

IsBuildable VPaned Source # 
Instance details

Defined in GI.Gtk.Objects.VPaned

IsBuildable VButtonBox Source # 
Instance details

Defined in GI.Gtk.Objects.VButtonBox

IsBuildable VBox Source # 
Instance details

Defined in GI.Gtk.Objects.VBox

IsBuildable UIManager Source # 
Instance details

Defined in GI.Gtk.Objects.UIManager

IsBuildable Toolbar Source # 
Instance details

Defined in GI.Gtk.Objects.Toolbar

IsBuildable TearoffMenuItem Source # 
Instance details

Defined in GI.Gtk.Objects.TearoffMenuItem

IsBuildable Table Source # 
Instance details

Defined in GI.Gtk.Objects.Table

IsBuildable Switch Source # 
Instance details

Defined in GI.Gtk.Objects.Switch

IsBuildable Statusbar Source # 
Instance details

Defined in GI.Gtk.Objects.Statusbar

IsBuildable StackSwitcher Source # 
Instance details

Defined in GI.Gtk.Objects.StackSwitcher

IsBuildable StackSidebar Source # 
Instance details

Defined in GI.Gtk.Objects.StackSidebar

IsBuildable Spinner Source # 
Instance details

Defined in GI.Gtk.Objects.Spinner

IsBuildable Socket Source # 
Instance details

Defined in GI.Gtk.Objects.Socket

IsBuildable ShortcutsShortcut Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutsShortcut

IsBuildable ShortcutsSection Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutsSection

IsBuildable ShortcutsGroup Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutsGroup

IsBuildable ShortcutLabel Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutLabel

IsBuildable SeparatorToolItem Source # 
Instance details

Defined in GI.Gtk.Objects.SeparatorToolItem

IsBuildable SeparatorMenuItem Source # 
Instance details

Defined in GI.Gtk.Objects.SeparatorMenuItem

IsBuildable SearchEntry Source # 
Instance details

Defined in GI.Gtk.Objects.SearchEntry

IsBuildable SearchBar Source # 
Instance details

Defined in GI.Gtk.Objects.SearchBar

IsBuildable Revealer Source # 
Instance details

Defined in GI.Gtk.Objects.Revealer

IsBuildable RecentChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.RecentChooserWidget

IsBuildable RecentChooserMenu Source # 
Instance details

Defined in GI.Gtk.Objects.RecentChooserMenu

IsBuildable RadioToolButton Source # 
Instance details

Defined in GI.Gtk.Objects.RadioToolButton

IsBuildable RadioMenuItem Source # 
Instance details

Defined in GI.Gtk.Objects.RadioMenuItem

IsBuildable ProgressBar Source # 
Instance details

Defined in GI.Gtk.Objects.ProgressBar

IsBuildable PopoverMenu Source # 
Instance details

Defined in GI.Gtk.Objects.PopoverMenu

IsBuildable PlacesSidebar Source # 
Instance details

Defined in GI.Gtk.Objects.PlacesSidebar

IsBuildable Overlay Source # 
Instance details

Defined in GI.Gtk.Objects.Overlay

IsBuildable Notebook Source # 
Instance details

Defined in GI.Gtk.Objects.Notebook

IsBuildable ModelButton Source # 
Instance details

Defined in GI.Gtk.Objects.ModelButton

IsBuildable MenuToolButton Source # 
Instance details

Defined in GI.Gtk.Objects.MenuToolButton

IsBuildable MenuButton Source # 
Instance details

Defined in GI.Gtk.Objects.MenuButton

IsBuildable MenuBar Source # 
Instance details

Defined in GI.Gtk.Objects.MenuBar

IsBuildable LockButton Source # 
Instance details

Defined in GI.Gtk.Objects.LockButton

IsBuildable LinkButton Source # 
Instance details

Defined in GI.Gtk.Objects.LinkButton

IsBuildable LevelBar Source # 
Instance details

Defined in GI.Gtk.Objects.LevelBar

IsBuildable Layout Source # 
Instance details

Defined in GI.Gtk.Objects.Layout

IsBuildable Invisible Source # 
Instance details

Defined in GI.Gtk.Objects.Invisible

IsBuildable InfoBar Source # 
Instance details

Defined in GI.Gtk.Objects.InfoBar

IsBuildable ImageMenuItem Source # 
Instance details

Defined in GI.Gtk.Objects.ImageMenuItem

IsBuildable HeaderBar Source # 
Instance details

Defined in GI.Gtk.Objects.HeaderBar

IsBuildable HandleBox Source # 
Instance details

Defined in GI.Gtk.Objects.HandleBox

IsBuildable HSeparator Source # 
Instance details

Defined in GI.Gtk.Objects.HSeparator

IsBuildable HScrollbar Source # 
Instance details

Defined in GI.Gtk.Objects.HScrollbar

IsBuildable HScale Source # 
Instance details

Defined in GI.Gtk.Objects.HScale

IsBuildable HSV Source # 
Instance details

Defined in GI.Gtk.Objects.HSV

IsBuildable HPaned Source # 
Instance details

Defined in GI.Gtk.Objects.HPaned

IsBuildable HButtonBox Source # 
Instance details

Defined in GI.Gtk.Objects.HButtonBox

IsBuildable HBox Source # 
Instance details

Defined in GI.Gtk.Objects.HBox

IsBuildable Grid Source # 
Instance details

Defined in GI.Gtk.Objects.Grid

IsBuildable GLArea Source # 
Instance details

Defined in GI.Gtk.Objects.GLArea

IsBuildable FontSelection Source # 
Instance details

Defined in GI.Gtk.Objects.FontSelection

IsBuildable FontChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.FontChooserWidget

IsBuildable FontButton Source # 
Instance details

Defined in GI.Gtk.Objects.FontButton

IsBuildable Fixed Source # 
Instance details

Defined in GI.Gtk.Objects.Fixed

IsBuildable FileChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.FileChooserWidget

IsBuildable FileChooserButton Source # 
Instance details

Defined in GI.Gtk.Objects.FileChooserButton

IsBuildable Expander Source # 
Instance details

Defined in GI.Gtk.Objects.Expander

IsBuildable EventBox Source # 
Instance details

Defined in GI.Gtk.Objects.EventBox

IsBuildable DrawingArea Source # 
Instance details

Defined in GI.Gtk.Objects.DrawingArea

IsBuildable ComboBoxText Source # 
Instance details

Defined in GI.Gtk.Objects.ComboBoxText

IsBuildable ColorSelection Source # 
Instance details

Defined in GI.Gtk.Objects.ColorSelection

IsBuildable ColorChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.ColorChooserWidget

IsBuildable ColorButton Source # 
Instance details

Defined in GI.Gtk.Objects.ColorButton

IsBuildable AspectFrame Source # 
Instance details

Defined in GI.Gtk.Objects.AspectFrame

IsBuildable Arrow Source # 
Instance details

Defined in GI.Gtk.Objects.Arrow

IsBuildable AppChooserWidget Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserWidget

IsBuildable AppChooserButton Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserButton

IsBuildable Alignment Source # 
Instance details

Defined in GI.Gtk.Objects.Alignment

IsBuildable ActionBar Source # 
Instance details

Defined in GI.Gtk.Objects.ActionBar

IsBuildable AccelLabel Source # 
Instance details

Defined in GI.Gtk.Objects.AccelLabel

IsBuildable Window Source # 
Instance details

Defined in GI.Gtk.Objects.Window

IsBuildable RecentChooserDialog Source # 
Instance details

Defined in GI.Gtk.Objects.RecentChooserDialog

IsBuildable Plug Source # 
Instance details

Defined in GI.Gtk.Objects.Plug

IsBuildable OffscreenWindow Source # 
Instance details

Defined in GI.Gtk.Objects.OffscreenWindow

IsBuildable MessageDialog Source # 
Instance details

Defined in GI.Gtk.Objects.MessageDialog

IsBuildable FontSelectionDialog Source # 
Instance details

Defined in GI.Gtk.Objects.FontSelectionDialog

IsBuildable FontChooserDialog Source # 
Instance details

Defined in GI.Gtk.Objects.FontChooserDialog

IsBuildable FileChooserDialog Source # 
Instance details

Defined in GI.Gtk.Objects.FileChooserDialog

IsBuildable ColorSelectionDialog Source # 
Instance details

Defined in GI.Gtk.Objects.ColorSelectionDialog

IsBuildable ColorChooserDialog Source # 
Instance details

Defined in GI.Gtk.Objects.ColorChooserDialog

IsBuildable ApplicationWindow Source # 
Instance details

Defined in GI.Gtk.Objects.ApplicationWindow

IsBuildable AppChooserDialog Source # 
Instance details

Defined in GI.Gtk.Objects.AppChooserDialog

IsBuildable AboutDialog Source # 
Instance details

Defined in GI.Gtk.Objects.AboutDialog

IsBuildable Image Source # 
Instance details

Defined in GI.Gtk.Objects.Image

IsBuildable ToolPalette Source # 
Instance details

Defined in GI.Gtk.Objects.ToolPalette

IsBuildable TextView Source # 
Instance details

Defined in GI.Gtk.Objects.TextView

IsBuildable TreeStore Source # 
Instance details

Defined in GI.Gtk.Objects.TreeStore

IsBuildable ListStore Source # 
Instance details

Defined in GI.Gtk.Objects.ListStore

IsBuildable CellView Source # 
Instance details

Defined in GI.Gtk.Objects.CellView

IsBuildable Assistant Source # 
Instance details

Defined in GI.Gtk.Objects.Assistant

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