Gtk::Builder Class Reference
Inheritance diagram for Gtk::Builder:
Detailed Description
Build an interface from a 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 interface is created. The Gtk::Builder object then provides an interface for accessing the widgets in the interface by the names assigned to them inside the UI description.
Public Member Functions | |
bool | add_from_file (const std::string& filename) |
Parses a file containing a GtkBuilder UI definition and merges it with the current contents of builder . | |
bool | add_from_string (const char* buffer, gsize length) |
Parses a string containing a GtkBuilder UI definition and merges it with the current contents of builder . | |
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. | |
Glib::RefPtr<Glib::Object> | get_object (const Glib::ustring& name) |
Gets the object named name . | |
Glib::ustring | get_translation_domain () const |
Gets the translation domain of builder . | |
template<class T_Widget> | |
void | get_widget (const Glib::ustring& name, T_Widget*& widget) |
Get a widget from the Builder file. | |
template<class T_Widget> | |
void | get_widget_derived (const Glib::ustring& name, T_Widget*& widget) |
This provides a pointer to a widget whose details are specified in the GtkBuilder file, but which is implemented by your own derived class. | |
const GtkBuilder* | gobj () const |
Provides access to the underlying C GObject. | |
GtkBuilder* | gobj () |
Provides access to the underlying C GObject. | |
GtkBuilder* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
void | set_translation_domain (const Glib::ustring& domain) |
Sets the translation domain of builder . | |
virtual | ~Builder () |
Static Public Member Functions | |
static Glib::RefPtr<Builder> | create () |
static Glib::RefPtr<Builder> | create_from_file (const std::string& filename) |
Parses a file containing a GtkBuilder UI definition. | |
static Glib::RefPtr<Builder> | create_from_string (const Glib::ustring& buffer) |
Parses a string containing a GtkBuilder UI definition. | |
Protected Member Functions | |
Builder () | |
GtkWidget* | get_cwidget (const Glib::ustring& name) |
Gtk::Widget* | get_widget_checked (const Glib::ustring& name, GType type) |
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. |
Constructor & Destructor Documentation
virtual Gtk::Builder::~Builder | ( | ) | [virtual] |
Gtk::Builder::Builder | ( | ) | [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 builder .
- Parameters:
-
filename The name of the file to parse. error Return location for an error, or 0
.
- Returns:
- A positive value on success, 0 if an error occurred
bool Gtk::Builder::add_from_string | ( | const char * | buffer, | |
gsize | length | |||
) |
Parses a string containing a GtkBuilder UI definition and merges it with the current contents of builder .
- Parameters:
-
buffer The string to parse. length The length of buffer (may be -1 if buffer is nul-terminated). error Return location for an error, or 0
.
- Returns:
- A positive value on success, 0 if an error occurred
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.
: the string to parse
- Returns:
- true on success or false if an error occurred.
- Exceptions:
-
Glib::MarkupError
static Glib::RefPtr<Builder> Gtk::Builder::create | ( | ) | [static] |
static Glib::RefPtr<Builder> Gtk::Builder::create_from_file | ( | const std::string & | filename | ) | [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:
-
Glib::FileError,Glib::MarkupError
static Glib::RefPtr<Builder> Gtk::Builder::create_from_string | ( | const Glib::ustring & | buffer | ) | [static] |
Parses a string containing a GtkBuilder UI definition.
: the string to parse
- Returns:
- A new Builder object, or a null pointer if an error occurred.
- Exceptions:
-
Glib::MarkupError
GtkWidget* Gtk::Builder::get_cwidget | ( | const Glib::ustring & | name | ) | [protected] |
Glib::RefPtr<Glib::Object> Gtk::Builder::get_object | ( | const Glib::ustring & | name | ) |
Gets the object named name .
Note that this function does not increment the reference count of the returned object.
- Parameters:
-
name Name of object to get.
- Returns:
- The object named name or
0
if it could not be found in the object tree.
Glib::ustring Gtk::Builder::get_translation_domain | ( | ) | const |
Gets the translation domain of builder .
- Returns:
- The translation domain. This string is owned by the builder object and must not be modified or freed.
void Gtk::Builder::get_widget | ( | const Glib::ustring & | name, | |
T_Widget *& | widget | |||
) | [inline] |
Get a widget from the Builder file.
For instance:
Gtk::Table* pTable = 0; refXml->get_widget("mytable", pTable);
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.
- Return values:
-
widget A pointer to the widget, or 0
on failure.
Gtk::Widget* Gtk::Builder::get_widget_checked | ( | const Glib::ustring & | name, | |
GType | type | |||
) | [protected] |
void Gtk::Builder::get_widget_derived | ( | const Glib::ustring & | name, | |
T_Widget *& | widget | |||
) | [inline] |
This provides a pointer to 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:
DerivedDialog::DerivedDialog(BaseObjectType* cobject, const Glib::RefPtr<Gtk::Builder>& refBuilder) : Gtk::Dialog(cobject) //Calls the base class constructor
For instance:
Gtk::DerivedBox* pBox = 0;
refXml->get_widget_derived("mybox", pBox);
- Parameters:
-
name The name of the widget.
- Return values:
-
widget A pointer to the widget, or 0
on failure.
const GtkBuilder* Gtk::Builder::gobj | ( | ) | const [inline] |
GtkBuilder* Gtk::Builder::gobj | ( | ) | [inline] |
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.
void Gtk::Builder::set_translation_domain | ( | const Glib::ustring & | domain | ) |
Sets the translation domain of builder .
See Gtk::Builder:translation-domain.
- Parameters:
-
domain The translation domain or 0
.
Friends And Related Function Documentation
Glib::RefPtr<Gtk::Builder> wrap | ( | GtkBuilder * | object, | |
bool | take_copy = false | |||
) | [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.
The documentation for this class was generated from the following file: