gtkmm: Gtk::Builder Class Reference
Build an interface from an XML UI definition description. More...
#include <gtkmm/builder.h>
Public Member Functions | |
Builder (Builder&& src) noexcept | |
Builder& | operator= (Builder&& src) noexcept |
~Builder () noexcept override | |
GtkBuilder* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkBuilder* | gobj () const |
Provides access to the underlying C GObject. More... | |
GtkBuilder* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
bool | add_from_file (const std::string& filename) |
Parses a file containing a GtkBuilder UI definition, and merges it with the current contents of the builder. More... | |
bool | add_from_file (const std::string& filename, const char* object_id) |
Parses a file containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder. More... | |
bool | add_from_file (const std::string& filename, const Glib::ustring& object_id) |
Parses a file containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder. More... | |
bool | add_from_file (const std::string& filename, const std::vector< Glib::ustring >& object_ids) |
Parses a file containing a [GtkBuilder UI definition][BUILDER-UI] building only the requested objects and merges them with the current contents of builder. More... | |
bool | add_from_resource (const std::string& resource_path) |
Parses a resource file containing a GtkBuilder UI definition, and merges it with the current contents of the builder. More... | |
bool | add_from_resource (const std::string& resource_path, const char* object_id) |
Parses a resource file containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder. More... | |
bool | add_from_resource (const std::string& resource_path, const Glib::ustring& object_id) |
Parses a resource file containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder. More... | |
bool | add_from_resource (const std::string& resource_path, const std::vector< Glib::ustring >& object_ids) |
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. More... | |
bool | add_from_string (const Glib::ustring& buffer) |
Parses a string containing a GtkBuilder UI definition and merges it with the current contents of the builder. More... | |
bool | add_from_string (const Glib::ustring& buffer, const char* object_id) |
Parses a string containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder. More... | |
bool | add_from_string (const Glib::ustring& buffer, const Glib::ustring& object_id) |
Parses a string containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder. More... | |
bool | add_from_string (const Glib::ustring& buffer, const std::vector< Glib::ustring >& object_ids) |
Parses a string containing a GtkBuilder UI definition, building only the requested objects, and merges it with the current contents of the builder. More... | |
bool | add_from_string (const char* buffer, gssize length) |
Parses a string containing a GtkBuilder UI definition and merges it with the current contents of the builder. More... | |
void | expose_object (const Glib::ustring& name, const Glib::RefPtr< Glib::Object >& object) |
Add object to the builder object pool so it can be referenced just like any other object built by builder. More... | |
void | expose_widget (const Glib::ustring& name, Widget& widget) |
Add widget to the builder object pool so it can be referenced just like any other object built by builder. More... | |
Glib::RefPtr< Glib::Object > | get_object (const Glib::ustring& name) |
Gets the object named name. More... | |
Glib::RefPtr< const Glib::Object > | get_object (const Glib::ustring& name) const |
Gets the object named name. More... | |
template<class T_Object > | |
Glib::RefPtr< T_Object > | get_object (const Glib::ustring& name) |
Gets the object named name, cast to a specific derived type. More... | |
template<class T_Object > | |
Glib::RefPtr< const T_Object > | get_object (const Glib::ustring& name) const |
See the non-const version. More... | |
template<class T_Widget > | |
T_Widget* | get_widget (const Glib::ustring& name) |
Gets a widget from the Builder file. More... | |
template<class T_Widget > | |
const T_Widget* | get_widget (const Glib::ustring& name) const |
See the non-const version. More... | |
std::vector< Glib::RefPtr< Glib::Object > > | get_objects () |
Gets all objects that have been constructed by the Gtk::Builder. More... | |
std::vector< Glib::RefPtr< const Glib::Object > > | get_objects () const |
Gets all objects that have been constructed by the Gtk::Builder. More... | |
void | set_translation_domain (const Glib::ustring& domain) |
Sets the translation domain of builder. More... | |
Glib::ustring | get_translation_domain () const |
Gets the translation domain of builder. More... | |
Glib::PropertyProxy< Glib::ustring > | property_translation_domain () |
The translation domain used when translating property values that have been marked as translatable in interface descriptions. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_translation_domain () const |
The translation domain used when translating property values that have been marked as translatable in interface descriptions. More... | |
Public Member Functions inherited from Glib::Object | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (Object &&src) noexcept |
void * | get_data (const QueryQuark &key) |
void | set_data (const Quark &key, void *data) |
void | set_data (const Quark &key, void *data, DestroyNotify notify) |
void | remove_data (const QueryQuark &quark) |
void * | steal_data (const QueryQuark &quark) |
Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
Public Member Functions inherited from Glib::ObjectBase | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (const ObjectBase &)=delete |
void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value) |
void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const |
void | set_property (const Glib::ustring &property_name, const PropertyType &value) |
void | get_property (const Glib::ustring &property_name, PropertyType &value) const |
PropertyType | get_property (const Glib::ustring &property_name) const |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot) |
void | freeze_notify () |
void | thaw_notify () |
virtual void | reference () const |
virtual void | unreference () const |
GObject * | gobj () |
const GObject * | gobj () const |
GObject * | gobj_copy () const |
Public Member Functions inherited from sigc::trackable | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) noexcept | |
~trackable () | |
void | add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) noexcept |
void | remove_destroy_notify_callback (notifiable *data) const |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static Glib::RefPtr< Builder > | create () |
Creates a new builder object. More... | |
static Glib::RefPtr< Builder > | create_from_file (const std::string& filename) |
Parses a file containing a GtkBuilder UI definition. More... | |
static Glib::RefPtr< Builder > | create_from_file (const std::string& filename, const Glib::ustring& object_id) |
Parses a file containing a GtkBuilder UI definition, building only the requested object. More... | |
static Glib::RefPtr< Builder > | create_from_file (const std::string& filename, const char* object_id) |
Parses a file containing a GtkBuilder UI definition, building only the requested object. More... | |
static Glib::RefPtr< Builder > | create_from_file (const std::string& filename, const std::vector< Glib::ustring >& object_ids) |
Parses a file containing a GtkBuilder UI definition, building only the requested objects. More... | |
static Glib::RefPtr< Builder > | create_from_resource (const std::string& resource_path) |
Parses a resource file containing a GtkBuilder UI definition. More... | |
static Glib::RefPtr< Builder > | create_from_resource (const std::string& resource_path, const Glib::ustring& object_id) |
Parses a resource file containing a GtkBuilder UI definition, building only the requested object. More... | |
static Glib::RefPtr< Builder > | create_from_resource (const std::string& resource_path, const char* object_id) |
Parses a resource file containing a GtkBuilder UI definition, building only the requested object. More... | |
static Glib::RefPtr< Builder > | create_from_resource (const std::string& resource_path, const std::vector< Glib::ustring >& object_ids) |
Parses a resource file containing a GtkBuilder UI definition, building only the requested objects. More... | |
static Glib::RefPtr< Builder > | create_from_string (const Glib::ustring& buffer) |
Parses a string containing a GtkBuilder UI definition. More... | |
static Glib::RefPtr< Builder > | create_from_string (const Glib::ustring& buffer, const char* object_id) |
Parses a string containing a GtkBuilder UI definition building only the requested object. More... | |
static Glib::RefPtr< Builder > | create_from_string (const Glib::ustring& buffer, const Glib::ustring& object_id) |
Parses a string containing a GtkBuilder UI definition building only the requested object. More... | |
static Glib::RefPtr< Builder > | create_from_string (const Glib::ustring& buffer, const std::vector< Glib::ustring >& object_ids) |
Parses a string containing a GtkBuilder UI definition building only the requested objects. More... | |
template<typename T_Widget , typename... Args> | |
static T_Widget* | get_widget_derived (const Glib::RefPtr< Gtk::Builder >& builder, const Glib::ustring& name, Args&&...args) |
Gets a widget whose details are specified in the GtkBuilder file, but which is implemented by your own derived class. More... | |
template<typename T_Widget , typename... Args> | |
static const T_Widget* | get_widget_derived (const Glib::RefPtr< const Gtk::Builder >& builder, const Glib::ustring& name, Args&&...args) |
See the non-const version. More... | |
Protected Member Functions | |
Builder () | |
Gtk::Widget* | get_widget_checked (const Glib::ustring& name, GType type) |
GtkWidget* | get_cwidget (const Glib::ustring& name) |
Protected Member Functions inherited from Glib::Object | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexcept override | |
Protected Member Functions inherited from Glib::ObjectBase | |
ObjectBase () | |
ObjectBase (const char *custom_type_name) | |
ObjectBase (const std::type_info &custom_type_info) | |
ObjectBase (ObjectBase &&src) noexcept | |
ObjectBase & | operator= (ObjectBase &&src) noexcept |
virtual | ~ObjectBase () noexcept=0 |
void | initialize (GObject *castitem) |
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gtk::Builder > | wrap (GtkBuilder* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
Public Types inherited from Glib::Object | |
typedef void(*)(gpointer data | DestroyNotify) |
Public Types inherited from sigc::trackable | |
typedef internal::func_destroy_notify | func_destroy_notify |
Public Types inherited from sigc::notifiable | |
typedef internal::func_destroy_notify | func_destroy_notify |
Detailed Description
Build an interface from an XML UI definition description.
This object represents an `instantiation' of an UI definition description. When one of these objects is created, the XML file is read, and the user interface is created. The Gtk::Builder object then provides an interface for accessing the widgets in the user interface by the names assigned to them inside the UI description.
A Gtk::Builder holds a reference to all objects that it has constructed and drops these references when it is deleted. This deletion 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 get them with get_widget() or get_widget_derived() and delete them to get rid of them and all the widgets they contain.
The methods get_widget() and get_widget_derived() 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 methods will stay around until the user explicitly deletes them. 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 before the builder is deleted to make use of them.
Non-widget objects need to be fetched with get_object() or get_objects() to keep them beyond the lifespan of the builder.
- Gtk::Builder and Glib::Property
- A derived widget that contains Glib::Property members must be registered with its own name in the GType system. It must be registered before any of the create_from_*() or add_from_*() methods are called, meaning that you may have to create an instance of your derived widget just to have its class registered. There is no reasonably easy way to combine Gtk::Builder with non-widget objects containing Glib::Property members. Combining it with widgets containing Glib::Property members requires glibmm 2.62 or newer. See also get_widget_derived() and Glib::Property.
Constructor & Destructor Documentation
|
noexcept |
|
overridenoexcept |
|
protected |
Member Function Documentation
bool Gtk::Builder::add_from_file | ( | const std::string & | filename | ) |
Parses a file containing a GtkBuilder UI definition, and merges it with the current contents of the builder.
- Parameters
-
filename The file to parse.
- Returns
- true on success or false if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Glib::MarkupError
bool Gtk::Builder::add_from_file | ( | const std::string & | filename, |
const char * | object_id | ||
) |
Parses a file containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder.
If you are adding an object that depends on an object that is not its child (for instance a GtkTreeView that depends on its GtkTreeModel), you have to explicitely list all of them.
- Parameters
-
filename The file to parse. object_id The object to build.
- Returns
- true on success or false if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Glib::MarkupError
bool Gtk::Builder::add_from_file | ( | const std::string & | filename, |
const Glib::ustring & | object_id | ||
) |
Parses a file containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder.
If you are adding an object that depends on an object that is not its child (for instance a GtkTreeView that depends on its GtkTreeModel), you have to explicitely list all of them.
- Parameters
-
filename The file to parse. object_id The object to build.
- Returns
- true on success or false if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Glib::MarkupError
bool Gtk::Builder::add_from_file | ( | const std::string & | filename, |
const std::vector< Glib::ustring > & | object_ids | ||
) |
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 Gtk::TreeView that depends on its Gtk::TreeModel), you have to explicitly list all of them in object_ids.
- Parameters
-
filename The name of the file to parse. object_ids Nul-terminated array of objects to build.
- Returns
true
on success,false
if an error occurred.
- Exceptions
-
Glib::Error
bool Gtk::Builder::add_from_resource | ( | const std::string & | resource_path | ) |
Parses a resource file containing a GtkBuilder UI definition, and merges it with the current contents of the builder.
- Parameters
-
resource_path The path of the resource file to parse.
- Returns
- true on success or false if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Gio::ResourceError
bool Gtk::Builder::add_from_resource | ( | const std::string & | resource_path, |
const char * | object_id | ||
) |
Parses a resource file containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder.
If you are adding an object that depends on an object that is not its child (for instance a GtkTreeView that depends on its GtkTreeModel), you have to explicitely list all of them.
- Parameters
-
resource_path The path of the resource file to parse. object_id The object to build.
- Returns
- true on success or false if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Gio::ResourceError
bool Gtk::Builder::add_from_resource | ( | const std::string & | resource_path, |
const Glib::ustring & | object_id | ||
) |
Parses a resource file containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder.
If you are adding an object that depends on an object that is not its child (for instance a GtkTreeView that depends on its GtkTreeModel), you have to explicitely list all of them.
- Parameters
-
resource_path The path of the resource file to parse. object_id The object to build.
- Returns
- true on success or false if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Gio::ResourceError
bool Gtk::Builder::add_from_resource | ( | const std::string & | resource_path, |
const std::vector< Glib::ustring > & | object_ids | ||
) |
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 Gtk::TreeView that depends on its Gtk::TreeModel), you have to explicitly list all of them in object_ids.
- Parameters
-
resource_path The path of the resource file to parse. object_ids Nul-terminated array of objects to build.
- Returns
true
on success,false
if an error occurred.
- Exceptions
-
Glib::Error
bool Gtk::Builder::add_from_string | ( | const Glib::ustring & | buffer | ) |
Parses a string containing a GtkBuilder UI definition and merges it with the current contents of the builder.
- Parameters
-
buffer The string to parse.
- Returns
- true on success or false if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError
bool Gtk::Builder::add_from_string | ( | const Glib::ustring & | buffer, |
const char * | object_id | ||
) |
Parses a string containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder.
- Parameters
-
buffer The string to parse. object_id The object to build.
- Returns
- true on success or false if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError
bool Gtk::Builder::add_from_string | ( | const Glib::ustring & | buffer, |
const Glib::ustring & | object_id | ||
) |
Parses a string containing a GtkBuilder UI definition, building only the requested object, and merges it with the current contents of the builder.
- Parameters
-
buffer The string to parse. object_id The object to build.
- Returns
- true on success or false if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError
bool Gtk::Builder::add_from_string | ( | const Glib::ustring & | buffer, |
const std::vector< Glib::ustring > & | object_ids | ||
) |
Parses a string containing a GtkBuilder UI definition, building only the requested objects, and merges it with the current contents of the builder.
- Parameters
-
buffer The string to parse. object_ids The objects to build.
- Returns
- true on success or false if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError
bool Gtk::Builder::add_from_string | ( | const char * | buffer, |
gssize | length | ||
) |
Parses a string containing a GtkBuilder UI definition and merges it with the current contents of the builder.
- Parameters
-
buffer The string to parse. length The length of buffer (may be -1 if buffer is nul-terminated).
- Returns
- true on success or false if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError
|
static |
Creates a new builder object.
|
static |
Parses a file containing a GtkBuilder UI definition.
- Parameters
-
filename the name of the file to parse.
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Glib::FileError
|
static |
Parses a file containing a GtkBuilder UI definition, building only the requested object.
If you are adding an object that depends on an object that is not its child (for instance a GtkTreeView that depends on its GtkTreeModel), you have to explicitely list all of them.
- Parameters
-
filename the name of the file to parse. object_id The object to build.
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Glib::FileError
|
static |
Parses a file containing a GtkBuilder UI definition, building only the requested object.
If you are adding an object that depends on an object that is not its child (for instance a GtkTreeView that depends on its GtkTreeModel), you have to explicitely list all of them.
- Parameters
-
filename the name of the file to parse. object_id The object to build.
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Glib::FileError
|
static |
Parses a file containing a GtkBuilder UI definition, building only the requested objects.
If you are adding an object that depends on an object that is not its child (for instance a GtkTreeView that depends on its GtkTreeModel), you have to explicitely list all of them.
- Parameters
-
filename the name of the file to parse. object_ids The objects to build.
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Glib::FileError
|
static |
Parses a resource file containing a GtkBuilder UI definition.
- Parameters
-
resource_path The path of the resource file to parse.
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Gio::ResourceError
|
static |
Parses a resource file containing a GtkBuilder UI definition, building only the requested object.
If you are adding an object that depends on an object that is not its child (for instance a GtkTreeView that depends on its GtkTreeModel), you have to explicitely list all of them.
- Parameters
-
resource_path The path of the resource file to parse. object_id The object to build.
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Gio::ResourceError
|
static |
Parses a resource file containing a GtkBuilder UI definition, building only the requested object.
If you are adding an object that depends on an object that is not its child (for instance a GtkTreeView that depends on its GtkTreeModel), you have to explicitely list all of them.
- Parameters
-
resource_path The path of the resource file to parse. object_id The object to build.
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Gio::ResourceError
|
static |
Parses a resource file containing a GtkBuilder UI definition, building only the requested objects.
If you are adding an object that depends on an object that is not its child (for instance a GtkTreeView that depends on its GtkTreeModel), you have to explicitely list all of them.
- Parameters
-
resource_path The path of the resource file to parse. object_ids The objects to build.
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError,Gio::ResourceError
|
static |
Parses a string containing a GtkBuilder UI definition.
- Parameters
-
buffer the string to parse
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError
|
static |
Parses a string containing a GtkBuilder UI definition building only the requested object.
- Parameters
-
buffer The string to parse. object_id The object to build.
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError
|
static |
Parses a string containing a GtkBuilder UI definition building only the requested object.
- Parameters
-
buffer The string to parse. object_id The object to build.
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError
|
static |
Parses a string containing a GtkBuilder UI definition building only the requested objects.
If you are adding an object that depends on an object that is not its child (for instance a GtkTreeView that depends on its GtkTreeModel), you have to explicitely list all of them.
- Parameters
-
buffer the string to parse object_ids The objects to build.
- Returns
- A new Builder object, or a null pointer if an error occurred.
- Exceptions
-
BuilderError,Glib::MarkupError
void Gtk::Builder::expose_object | ( | const Glib::ustring & | name, |
const Glib::RefPtr< Glib::Object > & | object | ||
) |
Add object to the builder object pool so it can be referenced just like any other object built by builder.
- Parameters
-
name The name of the object exposed to the builder. object The object to expose.
void Gtk::Builder::expose_widget | ( | const Glib::ustring & | name, |
Widget& | widget | ||
) |
Add widget to the builder object pool so it can be referenced just like any other object built by builder.
- Parameters
-
name The name of the widget exposed to the builder. widget The widget to expose.
|
protected |
Glib::RefPtr<Glib::Object> Gtk::Builder::get_object | ( | const Glib::ustring & | name | ) |
Gets the object named name.
- Parameters
-
name Name of object to get.
- Returns
- The object named name or
nullptr
if it could not be found in the object tree.
Glib::RefPtr<const Glib::Object> Gtk::Builder::get_object | ( | const Glib::ustring & | name | ) | const |
Gets the object named name.
- Parameters
-
name Name of object to get.
- Returns
- The object named name or
nullptr
if it could not be found in the object tree.
|
inline |
Gets the object named name, cast to a specific derived type.
For instance:
- Parameters
-
name Name of object to get.
- Returns
- The object named name or
nullptr
if it could not be found in the object tree or could not be cast to the specified type.
|
inline |
See the non-const version.
std::vector<Glib::RefPtr<Glib::Object> > Gtk::Builder::get_objects | ( | ) |
Gets all objects that have been constructed by the Gtk::Builder.
- Returns
- A vector containing all the objects constructed by the Gtk::Builder instance.
std::vector<Glib::RefPtr<const Glib::Object> > Gtk::Builder::get_objects | ( | ) | const |
Gets all objects that have been constructed by the Gtk::Builder.
- Returns
- A vector containing all the objects constructed by the Gtk::Builder instance.
Glib::ustring Gtk::Builder::get_translation_domain | ( | ) | const |
Gets the translation domain of builder.
- Returns
- The translation domain or
nullptr
in case it was never set or explicitly unset via set_translation_domain(). This string is owned by the builder object and must not be modified or freed.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Gets a widget from the Builder file.
For instance:
This method prints a warning message to the console if the widget doesn't exist or has the wrong type, so you don't need to check that manually.
Note that you are responsible for deleting top-level widgets (windows and dialogs) instantiated by the Builder object. Other widgets are instantiated as managed so they will be deleted automatically if you add them to a container widget.
- Parameters
-
name The name of the widget.
- Returns
- A pointer to the widget, or
nullptr
on failure.
|
inline |
See the non-const version.
|
protected |
|
inlinestatic |
Gets a widget whose details are specified in the GtkBuilder file, but which is implemented by your own derived class.
Your class must have a constructor like so:
or, with additional parameters, for example:
For instance:
- Note
- If get_widget_derived() is called more than once for the same widget (the same name), only the first call will call the widget's constructor. The following calls will return a pointer to the widget instance that was constructed by the first call.
- Gtk::Builder and Glib::Property
- If the widget contains Glib::Property members, your constructor must call the Glib::ObjectBase constructor with a new GType name: MyDerivedDialog::MyDerivedDialog(BaseObjectType* cobject, const Glib::RefPtr<Gtk::Builder>& refBuilder)Gtk::Dialog(cobject) // Calls the base class constructorm_my_property(*this, "my-property")
- Parameters
-
builder The Gtk::Builder from which to get the widget. name The name of the widget. args Additional arguments to pass to the constructor of the derived class.
- Returns
- A pointer to the widget, or
nullptr
on failure.
|
inlinestatic |
See the non-const version.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GtkBuilder* Gtk::Builder::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::PropertyProxy< Glib::ustring > Gtk::Builder::property_translation_domain | ( | ) |
The translation domain used when translating property values that have been marked as translatable in interface descriptions.
If the translation domain is nullptr
, Gtk::Builder uses gettext(), otherwise Glib::dgettext().
Default value: ""
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Builder::property_translation_domain | ( | ) | const |
The translation domain used when translating property values that have been marked as translatable in interface descriptions.
If the translation domain is nullptr
, Gtk::Builder uses gettext(), otherwise Glib::dgettext().
Default value: ""
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::Builder::set_translation_domain | ( | const Glib::ustring & | domain | ) |
Sets the translation domain of builder.
See Gtk::Builder::property_translation_domain().
- Parameters
-
domain The translation domain or nullptr
.
Friends And Related Function Documentation
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object The C instance. take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
- Returns
- A C++ instance that wraps this C instance.