Trait gtk::prelude::BuilderExt [−][src]
pub trait BuilderExt: 'static {}Show methods
fn add_from_resource(&self, resource_path: &str) -> Result<(), Error>; fn add_from_string(&self, buffer: &str) -> Result<(), Error>; fn add_objects_from_resource(
&self,
resource_path: &str,
object_ids: &[&str]
) -> Result<(), Error>; fn add_objects_from_string(
&self,
buffer: &str,
object_ids: &[&str]
) -> Result<(), Error>; fn expose_object<P: IsA<Object>>(&self, name: &str, object: &P); fn extend_with_template<P: IsA<Widget>>(
&self,
widget: &P,
template_type: Type,
buffer: &str
) -> Result<(), Error>; fn application(&self) -> Option<Application>; fn objects(&self) -> Vec<Object>; fn translation_domain(&self) -> Option<GString>; fn type_from_name(&self, type_name: &str) -> Type; fn set_application<P: IsA<Application>>(&self, application: &P); fn set_translation_domain(&self, domain: Option<&str>); fn value_from_string(
&self,
pspec: &ParamSpec,
string: &str
) -> Result<Value, Error>; fn value_from_string_type(
&self,
type_: Type,
string: &str
) -> Result<Value, Error>; fn connect_translation_domain_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId;
Expand description
Required methods
Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
and merges it with the current contents of self
.
Most users will probably want to use Builder::from_resource()
.
If an error occurs, 0 will be returned and error
will be assigned a
glib::Error
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()
.
resource_path
the path of the resource file to parse
Returns
A positive value on success, 0 if an error occurred
Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
and merges it with the current contents of self
.
Most users will probably want to use Builder::from_string()
.
Upon errors 0 will be returned and error
will be assigned a
glib::Error
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()
.
buffer
the string to parse
length
the length of buffer
(may be -1 if buffer
is nul-terminated)
Returns
A positive value on success, 0 if an error occurred
Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
building only the requested objects and merges
them with the current contents of self
.
Upon errors 0 will be returned and error
will be assigned a
glib::Error
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 object_ids
.
resource_path
the path of the resource file to parse
object_ids
nul-terminated array of objects to build
Returns
A positive value on success, 0 if an error occurred
Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
building only the requested objects and merges
them with the current contents of self
.
Upon errors 0 will be returned and error
will be assigned a
glib::Error
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 object_ids
.
buffer
the string to parse
length
the length of buffer
(may be -1 if buffer
is nul-terminated)
object_ids
nul-terminated array of objects to build
Returns
A positive value on success, 0 if an error occurred
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.
widget
the widget that is being extended
template_type
the type that the template is for
buffer
the string to parse
length
the length of buffer
(may be -1 if buffer
is nul-terminated)
Returns
A positive value on success, 0 if an error occurred
fn application(&self) -> Option<Application>
fn application(&self) -> Option<Application>
Gets the Application
associated with the builder.
The Application
is used for creating action proxies as requested
from XML that the builder is loading.
By default, the builder uses the default application: the one from
gio::Application::default()
. If you want to use another application
for constructing proxies, use set_application()
.
Returns
the application being used by the builder,
or None
fn translation_domain(&self) -> Option<GString>
fn translation_domain(&self) -> Option<GString>
Gets the translation domain of self
.
Returns
the translation domain. This string is owned by the builder object and must not be modified or freed.
fn type_from_name(&self, type_name: &str) -> Type
fn type_from_name(&self, type_name: &str) -> Type
fn set_application<P: IsA<Application>>(&self, application: &P)
fn set_application<P: IsA<Application>>(&self, application: &P)
Sets the application associated with self
.
You only need this function if there is more than one gio::Application
in your process. application
cannot be None
.
application
fn set_translation_domain(&self, domain: Option<&str>)
fn set_translation_domain(&self, domain: Option<&str>)
This function demarshals a value from a string. This function
calls [glib::Value::init()
][crate::glib::Value::init()] 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, GdkColor
, gdk::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
glib::Error
from the GTK_BUILDER_ERROR
domain.
pspec
the glib::ParamSpec
for the property
string
the string representation of the value
Returns
true
on success
value
the glib::Value
to store the result in
Like value_from_string()
, this function demarshals
a value from a string, but takes a GType
instead of glib::ParamSpec
.
This function calls [glib::Value::init()
][crate::glib::Value::init()] on the value
argument, so it
need not be initialised beforehand.
Upon errors false
will be returned and error
will be assigned a
glib::Error
from the GTK_BUILDER_ERROR
domain.
type_
the GType
of the value
string
the string representation of the value
Returns
true
on success
value
the glib::Value
to store the result in
fn connect_translation_domain_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId