Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- Overloaded methods
- addFromFile
- addFromResource
- addFromString
- addObjectsFromFile
- addObjectsFromResource
- addObjectsFromString
- createClosure
- exposeObject
- extendWithTemplate
- getCurrentObject
- getObject
- getObjects
- getScope
- getTranslationDomain
- getTypeFromName
- new
- newFromFile
- newFromResource
- newFromString
- setCurrentObject
- setScope
- setTranslationDomain
- valueFromString
- valueFromStringType
- Properties
A GtkBuilder is an auxiliary object that reads textual descriptions
of a user interface and instantiates the described objects. To create
a GtkBuilder from a user interface description, call
builderNewFromFile
, builderNewFromResource
or
builderNewFromString
.
In the (unusual) case that you want to add user interface
descriptions from multiple sources to the same GtkBuilder you can
call builderNew
to get an empty builder and populate it by
(multiple) calls to builderAddFromFile
,
builderAddFromResource
or builderAddFromString
.
A GtkBuilder holds a reference to all objects that it has constructed
and drops these references when it is finalized. This finalization can
cause the destruction of non-widget objects or widgets which are not
contained in a toplevel window. For toplevel windows constructed by a
builder, it is the responsibility of the user to call windowDestroy
to get rid of them and all the widgets they contain.
The functions builderGetObject
and builderGetObjects
can be used to access the widgets in the interface by the names assigned
to them inside the UI description. Toplevel windows returned by these
functions will stay around until the user explicitly destroys them
with windowDestroy
. Other widgets will either be part of a
larger hierarchy constructed by the builder (in which case you should
not have to worry about their lifecycle), or without a parent, in which
case they have to be added to some container to make use of them.
Non-widget objects need to be reffed with objectRef
to keep them
beyond the lifespan of the builder.
The function gtk_builder_connect_signals()
and variants thereof can be
used to connect handlers to the named signals in the description.
GtkBuilder parses textual descriptions of user interfaces which are specified in an XML format which can be roughly described by the RELAX NG schema below. We refer to these descriptions as “GtkBuilder UI definitions” or just “UI definitions” if the context is clear.
The toplevel element is <interface>. It optionally takes a “domain”
attribute, which will make the builder look for translated strings
using dgettext()
in the domain specified. This can also be done by
calling builderSetTranslationDomain
on the builder.
Objects are described by <object> elements, which can contain
<property> elements to set properties, <signal> elements which
connect signals to handlers, and <child> elements, which describe
child objects (most often widgets inside a container, but also e.g.
actions in an action group, or columns in a tree model). A <child>
element contains an <object> element which describes the child object.
The target toolkit version(s) are described by <requires> elements,
the “lib” attribute specifies the widget library in question (currently
the only supported value is “gtk+”) and the “version” attribute specifies
the target version in the form “<major>.<minor>”. The builder will error
out if the version requirements are not met.
Typically, the specific kind of object represented by an <object>
element is specified by the “class” attribute. If the type has not
been loaded yet, GTK+ tries to find the get_type()
function from the
class name by applying heuristics. This works in most cases, but if
necessary, it is possible to specify the name of the get_type()
function
explictly with the "type-func" attribute. As a special case, GtkBuilder
allows to use an object that has been constructed by a GtkUIManager
in
another part of the UI definition by specifying the id of the GtkUIManager
in the “constructor” attribute and the name of the object in the “id”
attribute.
Objects may be given a name with the “id” attribute, which allows the
application to retrieve them from the builder with builderGetObject
.
An id is also necessary to use the object as property value in other
parts of the UI definition. GTK+ reserves ids starting and ending
with ___ (3 underscores) for its own purposes.
Setting properties of objects is pretty straightforward with the
<property> element: the “name” attribute specifies the name of the
property, and the content of the element specifies the value.
If the “translatable” attribute is set to a true value, GTK+ uses
gettext()
(or dgettext()
if the builder has a translation domain set)
to find a translation for the value. This happens before the value
is parsed, so it can be used for properties of any type, but it is
probably most useful for string properties. It is also possible to
specify a context to disambiguate short strings, and comments which
may help the translators.
GtkBuilder can parse textual representations for the most common
property types: characters, strings, integers, floating-point numbers,
booleans (strings like “TRUE”, “t”, “yes”, “y”, “1” are interpreted
as True
, strings like “FALSE”, “f”, “no”, “n”, “0” are interpreted
as False
), enumerations (can be specified by their name, nick or
integer value), flags (can be specified by their name, nick, integer
value, optionally combined with “|”, e.g. “GTK_VISIBLE|GTK_REALIZED”)
and colors (in a format understood by rGBAParse
).
GVariants can be specified in the format understood by variantParse
,
and pixbufs can be specified as a filename of an image file to load.
Objects can be referred to by their name and by default refer to
objects declared in the local xml fragment and objects exposed via
builderExposeObject
. In general, GtkBuilder allows forward
references to objects — declared in the local xml; an object doesn’t
have to be constructed before it can be referred to. The exception
to this rule is that an object has to be constructed before it can
be used as the value of a construct-only property.
It is also possible to bind a property value to another object's
property value using the attributes
"bind-source" to specify the source object of the binding, and
optionally, "bind-property" and "bind-flags" to specify the
source property and source binding flags respectively.
Internally builder implements this using GBinding objects.
For more information see objectBindProperty
Sometimes it is necessary to refer to widgets which have implicitly
been constructed by GTK+ as part of a composite widget, to set
properties on them or to add further children (e.g. the vbox
of
a Dialog
). This can be achieved by setting the “internal-child”
property of the <child> element to a true value. Note that GtkBuilder
still requires an <object> element for the internal child, even if it
has already been constructed.
A number of widgets have different places where a child can be added (e.g. tabs vs. page content in notebooks). This can be reflected in a UI definition by specifying the “type” attribute on a <child> The possible values for the “type” attribute are described in the sections describing the widget-specific portions of UI definitions.
Signal handlers and function pointers
Signal handlers are set up with the <signal> element. The “name”
attribute specifies the name of the signal, and the “handler” attribute
specifies the function to connect to the signal.
The remaining attributes, “after”, “swapped” and “object”, have the
same meaning as the corresponding parameters of the
g_signal_connect_object()
or g_signal_connect_data()
functions. A
“last_modification_time” attribute is also allowed, but it does not
have a meaning to the builder.
If you rely on Module
support to lookup callbacks in the symbol table,
the following details should be noted:
When compiling applications for Windows, you must declare signal callbacks
with G_MODULE_EXPORT
, or they will not be put in the symbol table.
On Linux and Unices, this is not necessary; applications should instead
be compiled with the -Wl,--export-dynamic CFLAGS, and linked against
gmodule-export-2.0.
A GtkBuilder UI Definition
<interface> <object class="GtkDialog" id="dialog1"> <child internal-child="vbox"> <object class="GtkBox" id="vbox1"> <child internal-child="action_area"> <object class="GtkBox" id="hbuttonbox1"> <child> <object class="GtkButton" id="ok_button"> <property name="label">gtk-ok</property> <signal name="clicked" handler="ok_button_clicked"/> </object> </child> </object> </child> </object> </child> </object> </interface>
Beyond this general structure, several object classes define their own XML DTD fragments for filling in the ANY placeholders in the DTD above. Note that a custom element in a <child> element gets parsed by the custom tag handler of the parent object, while a custom element in an <object> element gets parsed by the custom tag handler of the object.
These XML fragments are explained in the documentation of the respective objects.
Additionally, since 3.10 a special <template> tag has been added to the format allowing one to define a widget class’s components. See the [GtkWidget documentation][composite-templates] for details.
Synopsis
- newtype Builder = Builder (ManagedPtr Builder)
- class (GObject o, IsDescendantOf Builder o) => IsBuilder o
- toBuilder :: (MonadIO m, IsBuilder o) => o -> m Builder
- builderAddFromFile :: (HasCallStack, MonadIO m, IsBuilder a) => a -> Text -> m ()
- builderAddFromResource :: (HasCallStack, MonadIO m, IsBuilder a) => a -> Text -> m ()
- builderAddFromString :: (HasCallStack, MonadIO m, IsBuilder a) => a -> Text -> Int64 -> m ()
- builderAddObjectsFromFile :: (HasCallStack, MonadIO m, IsBuilder a) => a -> Text -> [Text] -> m ()
- builderAddObjectsFromResource :: (HasCallStack, MonadIO m, IsBuilder a) => a -> Text -> [Text] -> m ()
- builderAddObjectsFromString :: (HasCallStack, MonadIO m, IsBuilder a) => a -> Text -> Int64 -> [Text] -> m ()
- builderCreateClosure :: (HasCallStack, MonadIO m, IsBuilder a, IsObject b) => a -> Text -> [BuilderClosureFlags] -> Maybe b -> m (Maybe (GClosure c))
- builderExposeObject :: (HasCallStack, MonadIO m, IsBuilder a, IsObject b) => a -> Text -> b -> m ()
- builderExtendWithTemplate :: (HasCallStack, MonadIO m, IsBuilder a, IsWidget b) => a -> b -> GType -> Text -> Int64 -> m ()
- builderGetCurrentObject :: (HasCallStack, MonadIO m, IsBuilder a) => a -> m (Maybe Object)
- builderGetObject :: (HasCallStack, MonadIO m, IsBuilder a) => a -> Text -> m (Maybe Object)
- builderGetObjects :: (HasCallStack, MonadIO m, IsBuilder a) => a -> m [Object]
- builderGetScope :: (HasCallStack, MonadIO m, IsBuilder a) => a -> m BuilderScope
- builderGetTranslationDomain :: (HasCallStack, MonadIO m, IsBuilder a) => a -> m (Maybe Text)
- builderGetTypeFromName :: (HasCallStack, MonadIO m, IsBuilder a) => a -> Text -> m GType
- builderNew :: (HasCallStack, MonadIO m) => m Builder
- builderNewFromFile :: (HasCallStack, MonadIO m) => Text -> m Builder
- builderNewFromResource :: (HasCallStack, MonadIO m) => Text -> m Builder
- builderNewFromString :: (HasCallStack, MonadIO m) => Text -> Int64 -> m Builder
- builderSetCurrentObject :: (HasCallStack, MonadIO m, IsBuilder a, IsObject b) => a -> Maybe b -> m ()
- builderSetScope :: (HasCallStack, MonadIO m, IsBuilder a, IsBuilderScope b) => a -> Maybe b -> m ()
- builderSetTranslationDomain :: (HasCallStack, MonadIO m, IsBuilder a) => a -> Maybe Text -> m ()
- builderValueFromString :: (HasCallStack, MonadIO m, IsBuilder a) => a -> GParamSpec -> Text -> m GValue
- builderValueFromStringType :: (HasCallStack, MonadIO m, IsBuilder a) => a -> GType -> Text -> m GValue
- clearBuilderCurrentObject :: (MonadIO m, IsBuilder o) => o -> m ()
- constructBuilderCurrentObject :: (IsBuilder o, MonadIO m, IsObject a) => a -> m (GValueConstruct o)
- getBuilderCurrentObject :: (MonadIO m, IsBuilder o) => o -> m (Maybe Object)
- setBuilderCurrentObject :: (MonadIO m, IsBuilder o, IsObject a) => o -> a -> m ()
- clearBuilderScope :: (MonadIO m, IsBuilder o) => o -> m ()
- constructBuilderScope :: (IsBuilder o, MonadIO m, IsBuilderScope a) => a -> m (GValueConstruct o)
- getBuilderScope :: (MonadIO m, IsBuilder o) => o -> m BuilderScope
- setBuilderScope :: (MonadIO m, IsBuilder o, IsBuilderScope a) => o -> a -> m ()
- clearBuilderTranslationDomain :: (MonadIO m, IsBuilder o) => o -> m ()
- constructBuilderTranslationDomain :: (IsBuilder o, MonadIO m) => Text -> m (GValueConstruct o)
- getBuilderTranslationDomain :: (MonadIO m, IsBuilder o) => o -> m (Maybe Text)
- setBuilderTranslationDomain :: (MonadIO m, IsBuilder o) => o -> Text -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Builder Source # | |
IsGValue Builder Source # | Convert |
ManagedPtrNewtype Builder Source # | |
Defined in GI.Gtk.Objects.Builder toManagedPtr :: Builder -> ManagedPtr Builder # | |
TypedObject Builder Source # | |
Defined in GI.Gtk.Objects.Builder | |
GObject Builder Source # | |
Defined in GI.Gtk.Objects.Builder | |
HasParentTypes Builder Source # | |
Defined in GI.Gtk.Objects.Builder | |
type ParentTypes Builder Source # | |
Defined in GI.Gtk.Objects.Builder |
class (GObject o, IsDescendantOf Builder o) => IsBuilder o Source #
Instances
(GObject o, IsDescendantOf Builder o) => IsBuilder o Source # | |
Defined in GI.Gtk.Objects.Builder |
Methods
Overloaded methods
addFromFile
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> Text |
|
-> m () | (Can throw |
Parses a file containing a [GtkBuilder UI definition][BUILDER-UI]
and merges it with the current contents of builder
.
Most users will probably want to use builderNewFromFile
.
If an error occurs, 0 will be returned and error
will be assigned a
GError
from the GTK_BUILDER_ERROR
, G_MARKUP_ERROR
or G_FILE_ERROR
domain.
It’s not really reasonable to attempt to handle failures of this
call. You should not use this function with untrusted files (ie:
files that are not part of your application). Broken Builder
files can easily crash your program, and it’s possible that memory
was leaked leading up to the reported failure. The only reasonable
thing to do when an error is detected is to call g_error()
.
addFromResource
builderAddFromResource Source #
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> Text |
|
-> m () | (Can throw |
Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
and merges it with the current contents of builder
.
Most users will probably want to use builderNewFromResource
.
If an error occurs, 0 will be returned and error
will be assigned a
GError
from the GTK_BUILDER_ERROR
, G_MARKUP_ERROR
or G_RESOURCE_ERROR
domain.
It’s not really reasonable to attempt to handle failures of this
call. The only reasonable thing to do when an error is detected is
to call g_error()
.
addFromString
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> Text |
|
-> Int64 |
|
-> m () | (Can throw |
Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
and merges it with the current contents of builder
.
Most users will probably want to use builderNewFromString
.
Upon errors False
will be returned and error
will be assigned a
GError
from the GTK_BUILDER_ERROR
, G_MARKUP_ERROR
or
G_VARIANT_PARSE_ERROR
domain.
It’s not really reasonable to attempt to handle failures of this
call. The only reasonable thing to do when an error is detected is
to call g_error()
.
addObjectsFromFile
builderAddObjectsFromFile Source #
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> Text |
|
-> [Text] |
|
-> m () | (Can throw |
Parses a file containing a [GtkBuilder UI definition][BUILDER-UI]
building only the requested objects and merges
them with the current contents of builder
.
Upon errors 0 will be returned and error
will be assigned a
GError
from the GTK_BUILDER_ERROR
, G_MARKUP_ERROR
or G_FILE_ERROR
domain.
If you are adding an object that depends on an object that is not
its child (for instance a TreeView
that depends on its
TreeModel
), you have to explicitly list all of them in objectIds
.
addObjectsFromResource
builderAddObjectsFromResource Source #
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> Text |
|
-> [Text] |
|
-> m () | (Can throw |
Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
building only the requested objects and merges
them with the current contents of builder
.
Upon errors 0 will be returned and error
will be assigned a
GError
from the GTK_BUILDER_ERROR
, G_MARKUP_ERROR
or G_RESOURCE_ERROR
domain.
If you are adding an object that depends on an object that is not
its child (for instance a TreeView
that depends on its
TreeModel
), you have to explicitly list all of them in objectIds
.
addObjectsFromString
builderAddObjectsFromString Source #
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> Text |
|
-> Int64 |
|
-> [Text] |
|
-> m () | (Can throw |
Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
building only the requested objects and merges
them with the current contents of builder
.
Upon errors False
will be returned and error
will be assigned a
GError
from the GTK_BUILDER_ERROR
or G_MARKUP_ERROR
domain.
If you are adding an object that depends on an object that is not
its child (for instance a TreeView
that depends on its
TreeModel
), you have to explicitly list all of them in objectIds
.
createClosure
:: (HasCallStack, MonadIO m, IsBuilder a, IsObject b) | |
=> a |
|
-> Text |
|
-> [BuilderClosureFlags] |
|
-> Maybe b |
|
-> m (Maybe (GClosure c)) | Returns: A new closure for invoking |
Creates a closure to invoke the function called functionName
.
If a closure function was set via gtk_builder_set_closure_func()
,
will be invoked.
Otherwise, gtk_builder_create_cclosure()
will be called.
If no closure could be created, Nothing
will be returned and error
will
be set.
exposeObject
:: (HasCallStack, MonadIO m, IsBuilder a, IsObject b) | |
=> a |
|
-> Text |
|
-> b |
|
-> m () |
Add object
to the builder
object pool so it can be referenced just like any
other object built by builder.
extendWithTemplate
builderExtendWithTemplate Source #
:: (HasCallStack, MonadIO m, IsBuilder a, IsWidget b) | |
=> a |
|
-> b |
|
-> GType |
|
-> Text |
|
-> Int64 |
|
-> m () | (Can throw |
Main private entry point for building composite container components from template XML.
This is exported purely to let gtk-builder-tool validate templates, applications have no need to call this function.
getCurrentObject
builderGetCurrentObject Source #
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> m (Maybe Object) | Returns: the current object |
Gets the current object set via builderSetCurrentObject
.
getObject
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> Text |
|
-> m (Maybe Object) | Returns: the object named |
Gets the object named name
. Note that this function does not
increment the reference count of the returned object.
getObjects
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> m [Object] | Returns: a newly-allocated |
Gets all objects that have been constructed by builder
. Note that
this function does not increment the reference counts of the returned
objects.
getScope
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> m BuilderScope | Returns: the current scope |
Gets the scope in use that was set via builderSetScope
.
See the BuilderScope
documentation for details.
getTranslationDomain
builderGetTranslationDomain Source #
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> m (Maybe Text) | Returns: the translation domain or |
Gets the translation domain of builder
.
getTypeFromName
new
:: (HasCallStack, MonadIO m) | |
=> m Builder | Returns: a new (empty) |
Creates a new empty builder object.
This function is only useful if you intend to make multiple calls
to builderAddFromFile
, builderAddFromResource
or builderAddFromString
in order to merge multiple UI
descriptions into a single builder.
Most users will probably want to use builderNewFromFile
,
builderNewFromResource
or builderNewFromString
.
newFromFile
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Builder | Returns: a |
Builds the [GtkBuilder UI definition][BUILDER-UI]
in the file filename
.
If there is an error opening the file or parsing the description then the program will be aborted. You should only ever attempt to parse user interface descriptions that are shipped as part of your program.
newFromResource
builderNewFromResource Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Builder | Returns: a |
Builds the [GtkBuilder UI definition][BUILDER-UI]
at resourcePath
.
If there is an error locating the resource or parsing the description, then the program will be aborted.
newFromString
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> Int64 |
|
-> m Builder | Returns: a |
Builds the user interface described by string
(in the
[GtkBuilder UI definition][BUILDER-UI] format).
If string
is Nothing
-terminated, then length
should be -1.
If length
is not -1, then it is the length of string
.
If there is an error parsing string
then the program will be
aborted. You should not attempt to parse user interface description
from untrusted sources.
setCurrentObject
builderSetCurrentObject Source #
:: (HasCallStack, MonadIO m, IsBuilder a, IsObject b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the current object for the builder
. The current object can be
tought of as the this
object that the builder is working for and
will often be used as the default object when an object is optional.
widgetInitTemplate
for example will set the current object to
the widget the template is inited for.
For functions like builderNewFromResource
, the current object
will be Nothing
.
setScope
:: (HasCallStack, MonadIO m, IsBuilder a, IsBuilderScope b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the scope the builder should operate in.
If scope
is Nothing
a new BuilderCScope
will be created.
See the BuilderScope
documentation for details.
setTranslationDomain
builderSetTranslationDomain Source #
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the translation domain of builder
.
See Builder
:translation-domain
.
valueFromString
builderValueFromString Source #
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> GParamSpec |
|
-> Text |
|
-> m GValue | (Can throw |
This function demarshals a value from a string. This function
calls valueInit
on the value
argument, so it need not be
initialised beforehand.
This function can handle char, uchar, boolean, int, uint, long,
ulong, enum, flags, float, double, string, RGBA
and
Adjustment
type values. Support for Widget
type values is
still to come.
Upon errors False
will be returned and error
will be assigned a
GError
from the GTK_BUILDER_ERROR
domain.
valueFromStringType
builderValueFromStringType Source #
:: (HasCallStack, MonadIO m, IsBuilder a) | |
=> a |
|
-> GType |
|
-> Text |
|
-> m GValue | (Can throw |
Like builderValueFromString
, this function demarshals
a value from a string, but takes a GType
instead of ParamSpec
.
This function calls valueInit
on the value
argument, so it
need not be initialised beforehand.
Upon errors False
will be returned and error
will be assigned a
GError
from the GTK_BUILDER_ERROR
domain.
Properties
currentObject
The object the builder is evaluating for.
clearBuilderCurrentObject :: (MonadIO m, IsBuilder o) => o -> m () Source #
Set the value of the “current-object
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#currentObject
constructBuilderCurrentObject :: (IsBuilder o, MonadIO m, IsObject a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “current-object
” property. This is rarely needed directly, but it is used by new
.
getBuilderCurrentObject :: (MonadIO m, IsBuilder o) => o -> m (Maybe Object) Source #
Get the value of the “current-object
” property.
When overloading is enabled, this is equivalent to
get
builder #currentObject
setBuilderCurrentObject :: (MonadIO m, IsBuilder o, IsObject a) => o -> a -> m () Source #
Set the value of the “current-object
” property.
When overloading is enabled, this is equivalent to
set
builder [ #currentObject:=
value ]
scope
The scope the builder is operating in
clearBuilderScope :: (MonadIO m, IsBuilder o) => o -> m () Source #
Set the value of the “scope
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#scope
constructBuilderScope :: (IsBuilder o, MonadIO m, IsBuilderScope a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “scope
” property. This is rarely needed directly, but it is used by new
.
getBuilderScope :: (MonadIO m, IsBuilder o) => o -> m BuilderScope Source #
Get the value of the “scope
” property.
When overloading is enabled, this is equivalent to
get
builder #scope
setBuilderScope :: (MonadIO m, IsBuilder o, IsBuilderScope a) => o -> a -> m () Source #
Set the value of the “scope
” property.
When overloading is enabled, this is equivalent to
set
builder [ #scope:=
value ]
translationDomain
The translation domain used when translating property values that
have been marked as translatable in interface descriptions.
If the translation domain is Nothing
, Builder
uses gettext()
,
otherwise dgettext
.
clearBuilderTranslationDomain :: (MonadIO m, IsBuilder o) => o -> m () Source #
Set the value of the “translation-domain
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#translationDomain
constructBuilderTranslationDomain :: (IsBuilder o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “translation-domain
” property. This is rarely needed directly, but it is used by new
.
getBuilderTranslationDomain :: (MonadIO m, IsBuilder o) => o -> m (Maybe Text) Source #
Get the value of the “translation-domain
” property.
When overloading is enabled, this is equivalent to
get
builder #translationDomain
setBuilderTranslationDomain :: (MonadIO m, IsBuilder o) => o -> Text -> m () Source #
Set the value of the “translation-domain
” property.
When overloading is enabled, this is equivalent to
set
builder [ #translationDomain:=
value ]