* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
- * License along with the Gnome Library; see the file COPYING.LIB. If not,
- * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
#include "gtkintl.h"
#include "gtkmarshalers.h"
#include "gtkmenu.h"
+#include "gtkmenushellprivate.h"
#include "gtkmenubar.h"
#include "gtkmenutoolbutton.h"
#include "gtkseparatormenuitem.h"
#include "gtkseparatortoolitem.h"
-#include "gtktearoffmenuitem.h"
#include "gtktoolbar.h"
-#include "gtkuimanager.h"
#include "gtkwindow.h"
#include "gtkprivate.h"
+#undef GDK_DEPRECATED
+#undef GDK_DEPRECATED_FOR
+#define GDK_DEPRECATED
+#define GDK_DEPRECATED_FOR(f)
+
+#include "gtkuimanager.h"
+#include "deprecated/gtktearoffmenuitem.h"
+
+/**
+ * SECTION:gtkuimanager
+ * @Short_description: Constructing menus and toolbars from an XML description
+ * @Title: GtkUIManager
+ * @See_also:#GtkBuilder
+ *
+ * A #GtkUIManager constructs a user interface (menus and toolbars) from
+ * one or more UI definitions, which reference actions from one or more
+ * action groups.
+ *
+ * <refsect2 id="XML-UI">
+ * <title>UI Definitions</title>
+ * <para>
+ * The UI definitions are specified in an XML format which can be
+ * roughly described by the following DTD.
+ *
+ * <note><para>
+ * Do not confuse the GtkUIManager UI Definitions described here with
+ * the similarly named <link linkend="BUILDER-UI">GtkBuilder UI
+ * Definitions</link>.
+ * </para></note>
+ *
+ * <programlisting>
+ * <![CDATA[
+ * <!ELEMENT ui (menubar|toolbar|popup|accelerator)* >
+ * <!ELEMENT menubar (menuitem|separator|placeholder|menu)* >
+ * <!ELEMENT menu (menuitem|separator|placeholder|menu)* >
+ * <!ELEMENT popup (menuitem|separator|placeholder|menu)* >
+ * <!ELEMENT toolbar (toolitem|separator|placeholder)* >
+ * <!ELEMENT placeholder (menuitem|toolitem|separator|placeholder|menu)* >
+ * <!ELEMENT menuitem EMPTY >
+ * <!ELEMENT toolitem (menu?) >
+ * <!ELEMENT separator EMPTY >
+ * <!ELEMENT accelerator EMPTY >
+ * <!ATTLIST menubar name #IMPLIED
+ * action #IMPLIED >
+ * <!ATTLIST toolbar name #IMPLIED
+ * action #IMPLIED >
+ * <!ATTLIST popup name #IMPLIED
+ * action #IMPLIED
+ * accelerators (true|false) #IMPLIED >
+ * <!ATTLIST placeholder name #IMPLIED
+ * action #IMPLIED >
+ * <!ATTLIST separator name #IMPLIED
+ * action #IMPLIED
+ * expand (true|false) #IMPLIED >
+ * <!ATTLIST menu name #IMPLIED
+ * action #REQUIRED
+ * position (top|bot) #IMPLIED >
+ * <!ATTLIST menuitem name #IMPLIED
+ * action #REQUIRED
+ * position (top|bot) #IMPLIED
+ * always-show-image (true|false) #IMPLIED >
+ * <!ATTLIST toolitem name #IMPLIED
+ * action #REQUIRED
+ * position (top|bot) #IMPLIED >
+ * <!ATTLIST accelerator name #IMPLIED
+ * action #REQUIRED >
+ * ]]>
+ * </programlisting>
+ * There are some additional restrictions beyond those specified in the
+ * DTD, e.g. every toolitem must have a toolbar in its anchestry and
+ * every menuitem must have a menubar or popup in its anchestry. Since
+ * a #GMarkup parser is used to parse the UI description, it must not only
+ * be valid XML, but valid #GMarkup.
+ *
+ * If a name is not specified, it defaults to the action. If an action is
+ * not specified either, the element name is used. The name and action
+ * attributes must not contain '/' characters after parsing (since that
+ * would mess up path lookup) and must be usable as XML attributes when
+ * enclosed in doublequotes, thus they must not '"' characters or references
+ * to the " entity.
+ *
+ * <example>
+ * <title>A UI definition</title>
+ * <programlisting><![CDATA[
+ * <ui>
+ * <menubar>
+ * <menu name="FileMenu" action="FileMenuAction">
+ * <menuitem name="New" action="New2Action" />
+ * <placeholder name="FileMenuAdditions" />
+ * </menu>
+ * <menu name="JustifyMenu" action="JustifyMenuAction">
+ * <menuitem name="Left" action="justify-left"/>
+ * <menuitem name="Centre" action="justify-center"/>
+ * <menuitem name="Right" action="justify-right"/>
+ * <menuitem name="Fill" action="justify-fill"/>
+ * </menu>
+ * </menubar>
+ * <toolbar action="toolbar1">
+ * <placeholder name="JustifyToolItems">
+ * <separator/>
+ * <toolitem name="Left" action="justify-left"/>
+ * <toolitem name="Centre" action="justify-center"/>
+ * <toolitem name="Right" action="justify-right"/>
+ * <toolitem name="Fill" action="justify-fill"/>
+ * <separator/>
+ * </placeholder>
+ * </toolbar>
+ * </ui>
+ * ]]></programlisting>
+ * </example>
+ *
+ * The constructed widget hierarchy is very similar to the element tree
+ * of the XML, with the exception that placeholders are merged into their
+ * parents. The correspondence of XML elements to widgets should be
+ * almost obvious:
+ * <variablelist>
+ * <varlistentry>
+ * <term>menubar</term>
+ * <listitem><para>a #GtkMenuBar</para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>toolbar</term>
+ * <listitem><para>a #GtkToolbar</para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>popup</term>
+ * <listitem><para>a toplevel #GtkMenu</para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>menu</term>
+ * <listitem><para>a #GtkMenu attached to a menuitem</para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>menuitem</term>
+ * <listitem><para>a #GtkMenuItem subclass, the exact type depends on the
+ * action</para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>toolitem</term>
+ * <listitem><para>a #GtkToolItem subclass, the exact type depends on the
+ * action. Note that toolitem elements may contain a menu element, but only
+ * if their associated action specifies a #GtkMenuToolButton as proxy.</para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>separator</term>
+ * <listitem><para>a #GtkSeparatorMenuItem or
+ * #GtkSeparatorToolItem</para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>accelerator</term>
+ * <listitem><para>a keyboard accelerator</para></listitem>
+ * </varlistentry>
+ * </variablelist>
+ *
+ * The "position" attribute determines where a constructed widget is positioned
+ * wrt. to its siblings in the partially constructed tree. If it is
+ * "top", the widget is prepended, otherwise it is appended.
+ * </para>
+ * </refsect2>
+ * <refsect2 id="UI-Merging">
+ * <title>UI Merging</title>
+ * <para>
+ * The most remarkable feature of #GtkUIManager is that it can overlay a set
+ * of menuitems and toolitems over another one, and demerge them later.
+ *
+ * Merging is done based on the names of the XML elements. Each element is
+ * identified by a path which consists of the names of its anchestors, separated
+ * by slashes. For example, the menuitem named "Left" in the example above
+ * has the path <literal>/ui/menubar/JustifyMenu/Left</literal> and the
+ * toolitem with the same name has path
+ * <literal>/ui/toolbar1/JustifyToolItems/Left</literal>.
+ * </para>
+ * </refsect2>
+ * <refsect2>
+ * <title>Accelerators</title>
+ * <para>
+ * Every action has an accelerator path. Accelerators are installed together with
+ * menuitem proxies, but they can also be explicitly added with <accelerator>
+ * elements in the UI definition. This makes it possible to have accelerators for
+ * actions even if they have no visible proxies.
+ * </para>
+ * </refsect2>
+ * <refsect2 id="Smart-Separators">
+ * <title>Smart Separators</title>
+ * <para>
+ * The separators created by #GtkUIManager are "smart", i.e. they do not show up
+ * in the UI unless they end up between two visible menu or tool items. Separators
+ * which are located at the very beginning or end of the menu or toolbar
+ * containing them, or multiple separators next to each other, are hidden. This
+ * is a useful feature, since the merging of UI elements from multiple sources
+ * can make it hard or impossible to determine in advance whether a separator
+ * will end up in such an unfortunate position.
+ *
+ * For separators in toolbars, you can set <literal>expand="true"</literal> to
+ * turn them from a small, visible separator to an expanding, invisible one.
+ * Toolitems following an expanding separator are effectively right-aligned.
+ * </para>
+ * </refsect2>
+ * <refsect2>
+ * <title>Empty Menus</title>
+ * <para>
+ * Submenus pose similar problems to separators inconnection with merging. It is
+ * impossible to know in advance whether they will end up empty after merging.
+ * #GtkUIManager offers two ways to treat empty submenus:
+ * <itemizedlist>
+ * <listitem>
+ * <para>make them disappear by hiding the menu item they're attached to</para>
+ * </listitem>
+ * <listitem>
+ * <para>add an insensitive "Empty" item</para>
+ * </listitem>
+ * </itemizedlist>
+ * The behaviour is chosen based on the "hide_if_empty" property of the action
+ * to which the submenu is associated.
+ * </para>
+ * </refsect2>
+ * <refsect2 id="GtkUIManager-BUILDER-UI">
+ * <title>GtkUIManager as GtkBuildable</title>
+ * <para>
+ * The GtkUIManager implementation of the GtkBuildable interface accepts
+ * GtkActionGroup objects as <child> elements in UI definitions.
+ *
+ * A GtkUIManager UI definition as described above can be embedded in
+ * an GtkUIManager <object> element in a GtkBuilder UI definition.
+ *
+ * The widgets that are constructed by a GtkUIManager can be embedded in
+ * other parts of the constructed user interface with the help of the
+ * "constructor" attribute. See the example below.
+ *
+ * <example>
+ * <title>An embedded GtkUIManager UI definition</title>
+ * <programlisting><![CDATA[
+ * <object class="GtkUIManager" id="uiman">
+ * <child>
+ * <object class="GtkActionGroup" id="actiongroup">
+ * <child>
+ * <object class="GtkAction" id="file">
+ * <property name="label">_File</property>
+ * </object>
+ * </child>
+ * </object>
+ * </child>
+ * <ui>
+ * <menubar name="menubar1">
+ * <menu action="file">
+ * </menu>
+ * </menubar>
+ * </ui>
+ * </object>
+ * <object class="GtkWindow" id="main-window">
+ * <child>
+ * <object class="GtkMenuBar" id="menubar1" constructor="uiman"/>
+ * </child>
+ * </object>
+ * ]]></programlisting>
+ * </example>
+ * </para>
+ * </refsect2>
+ */
+
+
#undef DEBUG_UI_MANAGER
typedef enum
const gchar *path);
static GtkAction * gtk_ui_manager_real_get_action (GtkUIManager *manager,
const gchar *path);
-static void queue_update (GtkUIManager *self);
-static void dirty_all_nodes (GtkUIManager *self);
+static void queue_update (GtkUIManager *manager);
+static void dirty_all_nodes (GtkUIManager *manager);
static void mark_node_dirty (GNode *node);
-static GNode * get_child_node (GtkUIManager *self,
+static GNode * get_child_node (GtkUIManager *manager,
GNode *parent,
GNode *sibling,
const gchar *childname,
NodeType node_type,
gboolean create,
gboolean top);
-static GNode * get_node (GtkUIManager *self,
+static GNode * get_node (GtkUIManager *manager,
const gchar *path,
NodeType node_type,
gboolean create);
GObject *child,
const gchar *tagname,
gpointer *data);
+static void gtk_ui_manager_do_set_add_tearoffs (GtkUIManager *manager,
+ gboolean add_tearoffs);
* menus never have tearoff menu items.
*
* Since: 2.4
+ *
+ * Deprecated: 3.4: Tearoff menus are deprecated and should not
+ * be used in newly written code.
*/
g_object_class_install_property (gobject_class,
PROP_ADD_TEAROFFS,
P_("Add tearoffs to menus"),
P_("Whether tearoff menu items should be added to menus"),
FALSE,
- GTK_PARAM_READWRITE));
+ GTK_PARAM_READWRITE | G_PARAM_DEPRECATED));
g_object_class_install_property (gobject_class,
PROP_UI,
/**
* GtkUIManager::add-widget:
- * @merge: a #GtkUIManager
+ * @manager: a #GtkUIManager
* @widget: the added widget
*
* The ::add-widget signal is emitted for each generated menubar and toolbar.
/**
* GtkUIManager::actions-changed:
- * @merge: a #GtkUIManager
+ * @manager: a #GtkUIManager
*
* The ::actions-changed signal is emitted whenever the set of actions
* changes.
/**
* GtkUIManager::connect-proxy:
- * @uimanager: the ui manager
+ * @manager: the ui manager
* @action: the action
* @proxy: the proxy
*
/**
* GtkUIManager::disconnect-proxy:
- * @uimanager: the ui manager
+ * @manager: the ui manager
* @action: the action
* @proxy: the proxy
*
/**
* GtkUIManager::pre-activate:
- * @uimanager: the ui manager
+ * @manager: the ui manager
* @action: the action
*
* The ::pre-activate signal is emitted just before the @action
/**
* GtkUIManager::post-activate:
- * @uimanager: the ui manager
+ * @manager: the ui manager
* @action: the action
*
* The ::post-activate signal is emitted just after the @action
static void
-gtk_ui_manager_init (GtkUIManager *self)
+gtk_ui_manager_init (GtkUIManager *manager)
{
guint merge_id;
GNode *node;
- self->private_data = G_TYPE_INSTANCE_GET_PRIVATE (self,
- GTK_TYPE_UI_MANAGER,
- GtkUIManagerPrivate);
+ manager->private_data = G_TYPE_INSTANCE_GET_PRIVATE (manager,
+ GTK_TYPE_UI_MANAGER,
+ GtkUIManagerPrivate);
- self->private_data->accel_group = gtk_accel_group_new ();
+ manager->private_data->accel_group = gtk_accel_group_new ();
- self->private_data->root_node = NULL;
- self->private_data->action_groups = NULL;
+ manager->private_data->root_node = NULL;
+ manager->private_data->action_groups = NULL;
- self->private_data->last_merge_id = 0;
- self->private_data->add_tearoffs = FALSE;
+ manager->private_data->last_merge_id = 0;
+ manager->private_data->add_tearoffs = FALSE;
- merge_id = gtk_ui_manager_new_merge_id (self);
- node = get_child_node (self, NULL, NULL, "ui", 2,
+ merge_id = gtk_ui_manager_new_merge_id (manager);
+ node = get_child_node (manager, NULL, NULL, "ui", 2,
NODE_TYPE_ROOT, TRUE, FALSE);
node_prepend_ui_reference (node, merge_id, 0);
}
static void
gtk_ui_manager_finalize (GObject *object)
{
- GtkUIManager *self = GTK_UI_MANAGER (object);
+ GtkUIManager *manager = GTK_UI_MANAGER (object);
- if (self->private_data->update_tag != 0)
+ if (manager->private_data->update_tag != 0)
{
- g_source_remove (self->private_data->update_tag);
- self->private_data->update_tag = 0;
+ g_source_remove (manager->private_data->update_tag);
+ manager->private_data->update_tag = 0;
}
- g_node_traverse (self->private_data->root_node,
+ g_node_traverse (manager->private_data->root_node,
G_POST_ORDER, G_TRAVERSE_ALL, -1,
(GNodeTraverseFunc)free_node, NULL);
- g_node_destroy (self->private_data->root_node);
- self->private_data->root_node = NULL;
+ g_node_destroy (manager->private_data->root_node);
+ manager->private_data->root_node = NULL;
- g_list_foreach (self->private_data->action_groups,
- (GFunc) g_object_unref, NULL);
- g_list_free (self->private_data->action_groups);
- self->private_data->action_groups = NULL;
+ g_list_free_full (manager->private_data->action_groups, g_object_unref);
+ manager->private_data->action_groups = NULL;
- g_object_unref (self->private_data->accel_group);
- self->private_data->accel_group = NULL;
+ g_object_unref (manager->private_data->accel_group);
+ manager->private_data->accel_group = NULL;
G_OBJECT_CLASS (gtk_ui_manager_parent_class)->finalize (object);
}
GObject *child,
const gchar *type)
{
- GtkUIManager *self = GTK_UI_MANAGER (buildable);
+ GtkUIManager *manager = GTK_UI_MANAGER (buildable);
guint pos;
g_return_if_fail (GTK_IS_ACTION_GROUP (child));
- pos = g_list_length (self->private_data->action_groups);
+ pos = g_list_length (manager->private_data->action_groups);
- g_object_ref (child);
- gtk_ui_manager_insert_action_group (self,
+ gtk_ui_manager_insert_action_group (manager,
GTK_ACTION_GROUP (child),
pos);
}
const GValue *value,
GParamSpec *pspec)
{
- GtkUIManager *self = GTK_UI_MANAGER (object);
+ GtkUIManager *manager = GTK_UI_MANAGER (object);
switch (prop_id)
{
case PROP_ADD_TEAROFFS:
- gtk_ui_manager_set_add_tearoffs (self, g_value_get_boolean (value));
+ gtk_ui_manager_do_set_add_tearoffs (manager, g_value_get_boolean (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
GValue *value,
GParamSpec *pspec)
{
- GtkUIManager *self = GTK_UI_MANAGER (object);
+ GtkUIManager *manager = GTK_UI_MANAGER (object);
switch (prop_id)
{
case PROP_ADD_TEAROFFS:
- g_value_set_boolean (value, self->private_data->add_tearoffs);
+ g_value_set_boolean (value, manager->private_data->add_tearoffs);
break;
case PROP_UI:
- g_value_take_string (value, gtk_ui_manager_get_ui (self));
+ g_value_take_string (value, gtk_ui_manager_get_ui (manager));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
static GtkWidget *
-gtk_ui_manager_real_get_widget (GtkUIManager *self,
+gtk_ui_manager_real_get_widget (GtkUIManager *manager,
const gchar *path)
{
GNode *node;
/* ensure that there are no pending updates before we get the
* widget */
- gtk_ui_manager_ensure_update (self);
+ gtk_ui_manager_ensure_update (manager);
- node = get_node (self, path, NODE_TYPE_UNDECIDED, FALSE);
+ node = get_node (manager, path, NODE_TYPE_UNDECIDED, FALSE);
if (node == NULL)
return NULL;
}
static GtkAction *
-gtk_ui_manager_real_get_action (GtkUIManager *self,
+gtk_ui_manager_real_get_action (GtkUIManager *manager,
const gchar *path)
{
GNode *node;
/* ensure that there are no pending updates before we get
* the action */
- gtk_ui_manager_ensure_update (self);
+ gtk_ui_manager_ensure_update (manager);
- node = get_node (self, path, NODE_TYPE_UNDECIDED, FALSE);
+ node = get_node (manager, path, NODE_TYPE_UNDECIDED, FALSE);
if (node == NULL)
return NULL;
/**
* gtk_ui_manager_get_add_tearoffs:
- * @self: a #GtkUIManager
+ * @manager: a #GtkUIManager
*
* Returns whether menus generated by this #GtkUIManager
* will have tearoff menu items.
* Return value: whether tearoff menu items are added
*
* Since: 2.4
+ *
+ * Deprecated: 3.4: Tearoff menus are deprecated and should not
+ * be used in newly written code.
**/
gboolean
-gtk_ui_manager_get_add_tearoffs (GtkUIManager *self)
+gtk_ui_manager_get_add_tearoffs (GtkUIManager *manager)
{
- g_return_val_if_fail (GTK_IS_UI_MANAGER (self), FALSE);
+ g_return_val_if_fail (GTK_IS_UI_MANAGER (manager), FALSE);
- return self->private_data->add_tearoffs;
+ return manager->private_data->add_tearoffs;
}
/**
* gtk_ui_manager_set_add_tearoffs:
- * @self: a #GtkUIManager
+ * @manager: a #GtkUIManager
* @add_tearoffs: whether tearoff menu items are added
*
* Sets the "add_tearoffs" property, which controls whether menus
* menus never have tearoff menu items.
*
* Since: 2.4
+ *
+ * Deprecated: 3.4: Tearoff menus are deprecated and should not
+ * be used in newly written code.
**/
-void
-gtk_ui_manager_set_add_tearoffs (GtkUIManager *self,
- gboolean add_tearoffs)
+void
+gtk_ui_manager_set_add_tearoffs (GtkUIManager *manager,
+ gboolean add_tearoffs)
{
- g_return_if_fail (GTK_IS_UI_MANAGER (self));
+ g_return_if_fail (GTK_IS_UI_MANAGER (manager));
+
+ gtk_ui_manager_do_set_add_tearoffs (manager, add_tearoffs);
+}
+static void
+gtk_ui_manager_do_set_add_tearoffs (GtkUIManager *manager,
+ gboolean add_tearoffs)
+{
add_tearoffs = add_tearoffs != FALSE;
- if (add_tearoffs != self->private_data->add_tearoffs)
+ if (add_tearoffs != manager->private_data->add_tearoffs)
{
- self->private_data->add_tearoffs = add_tearoffs;
-
- dirty_all_nodes (self);
+ manager->private_data->add_tearoffs = add_tearoffs;
+
+ dirty_all_nodes (manager);
- g_object_notify (G_OBJECT (self), "add-tearoffs");
+ g_object_notify (G_OBJECT (manager), "add-tearoffs");
}
}
cb_proxy_connect_proxy (GtkActionGroup *group,
GtkAction *action,
GtkWidget *proxy,
- GtkUIManager *self)
+ GtkUIManager *manager)
{
- g_signal_emit (self, ui_manager_signals[CONNECT_PROXY], 0, action, proxy);
+ g_signal_emit (manager, ui_manager_signals[CONNECT_PROXY], 0, action, proxy);
}
static void
cb_proxy_disconnect_proxy (GtkActionGroup *group,
GtkAction *action,
GtkWidget *proxy,
- GtkUIManager *self)
+ GtkUIManager *manager)
{
- g_signal_emit (self, ui_manager_signals[DISCONNECT_PROXY], 0, action, proxy);
+ g_signal_emit (manager, ui_manager_signals[DISCONNECT_PROXY], 0, action, proxy);
}
static void
cb_proxy_pre_activate (GtkActionGroup *group,
GtkAction *action,
- GtkUIManager *self)
+ GtkUIManager *manager)
{
- g_signal_emit (self, ui_manager_signals[PRE_ACTIVATE], 0, action);
+ g_signal_emit (manager, ui_manager_signals[PRE_ACTIVATE], 0, action);
}
static void
cb_proxy_post_activate (GtkActionGroup *group,
GtkAction *action,
- GtkUIManager *self)
+ GtkUIManager *manager)
{
- g_signal_emit (self, ui_manager_signals[POST_ACTIVATE], 0, action);
+ g_signal_emit (manager, ui_manager_signals[POST_ACTIVATE], 0, action);
}
/**
* gtk_ui_manager_insert_action_group:
- * @self: a #GtkUIManager object
+ * @manager: a #GtkUIManager object
* @action_group: the action group to be inserted
* @pos: the position at which the group will be inserted.
*
* Inserts an action group into the list of action groups associated
- * with @self. Actions in earlier groups hide actions with the same
+ * with @manager. Actions in earlier groups hide actions with the same
* name in later groups.
*
+ * If @pos is larger than the number of action groups in @manager, or
+ * negative, @action_group will be inserted at the end of the internal
+ * list.
+ *
* Since: 2.4
**/
void
-gtk_ui_manager_insert_action_group (GtkUIManager *self,
+gtk_ui_manager_insert_action_group (GtkUIManager *manager,
GtkActionGroup *action_group,
gint pos)
{
const char *group_name;
#endif
- g_return_if_fail (GTK_IS_UI_MANAGER (self));
+ g_return_if_fail (GTK_IS_UI_MANAGER (manager));
g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
- g_return_if_fail (g_list_find (self->private_data->action_groups,
+ g_return_if_fail (g_list_find (manager->private_data->action_groups,
action_group) == NULL);
#ifdef G_ENABLE_DEBUG
group_name = gtk_action_group_get_name (action_group);
- for (l = self->private_data->action_groups; l; l = l->next)
+ for (l = manager->private_data->action_groups; l; l = l->next)
{
GtkActionGroup *group = l->data;
#endif /* G_ENABLE_DEBUG */
g_object_ref (action_group);
- self->private_data->action_groups =
- g_list_insert (self->private_data->action_groups, action_group, pos);
+ manager->private_data->action_groups =
+ g_list_insert (manager->private_data->action_groups, action_group, pos);
g_object_connect (action_group,
- "object-signal::connect-proxy", G_CALLBACK (cb_proxy_connect_proxy), self,
- "object-signal::disconnect-proxy", G_CALLBACK (cb_proxy_disconnect_proxy), self,
- "object-signal::pre-activate", G_CALLBACK (cb_proxy_pre_activate), self,
- "object-signal::post-activate", G_CALLBACK (cb_proxy_post_activate), self,
+ "object-signal::connect-proxy", G_CALLBACK (cb_proxy_connect_proxy), manager,
+ "object-signal::disconnect-proxy", G_CALLBACK (cb_proxy_disconnect_proxy), manager,
+ "object-signal::pre-activate", G_CALLBACK (cb_proxy_pre_activate), manager,
+ "object-signal::post-activate", G_CALLBACK (cb_proxy_post_activate), manager,
NULL);
/* dirty all nodes, as action bindings may change */
- dirty_all_nodes (self);
+ dirty_all_nodes (manager);
- g_signal_emit (self, ui_manager_signals[ACTIONS_CHANGED], 0);
+ g_signal_emit (manager, ui_manager_signals[ACTIONS_CHANGED], 0);
}
/**
* gtk_ui_manager_remove_action_group:
- * @self: a #GtkUIManager object
+ * @manager: a #GtkUIManager object
* @action_group: the action group to be removed
*
* Removes an action group from the list of action groups associated
- * with @self.
+ * with @manager.
*
* Since: 2.4
**/
void
-gtk_ui_manager_remove_action_group (GtkUIManager *self,
+gtk_ui_manager_remove_action_group (GtkUIManager *manager,
GtkActionGroup *action_group)
{
- g_return_if_fail (GTK_IS_UI_MANAGER (self));
+ g_return_if_fail (GTK_IS_UI_MANAGER (manager));
g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
- g_return_if_fail (g_list_find (self->private_data->action_groups,
+ g_return_if_fail (g_list_find (manager->private_data->action_groups,
action_group) != NULL);
- self->private_data->action_groups =
- g_list_remove (self->private_data->action_groups, action_group);
+ manager->private_data->action_groups =
+ g_list_remove (manager->private_data->action_groups, action_group);
g_object_disconnect (action_group,
- "any-signal::connect-proxy", G_CALLBACK (cb_proxy_connect_proxy), self,
- "any-signal::disconnect-proxy", G_CALLBACK (cb_proxy_disconnect_proxy), self,
- "any-signal::pre-activate", G_CALLBACK (cb_proxy_pre_activate), self,
- "any-signal::post-activate", G_CALLBACK (cb_proxy_post_activate), self,
+ "any-signal::connect-proxy", G_CALLBACK (cb_proxy_connect_proxy), manager,
+ "any-signal::disconnect-proxy", G_CALLBACK (cb_proxy_disconnect_proxy), manager,
+ "any-signal::pre-activate", G_CALLBACK (cb_proxy_pre_activate), manager,
+ "any-signal::post-activate", G_CALLBACK (cb_proxy_post_activate), manager,
NULL);
g_object_unref (action_group);
/* dirty all nodes, as action bindings may change */
- dirty_all_nodes (self);
+ dirty_all_nodes (manager);
- g_signal_emit (self, ui_manager_signals[ACTIONS_CHANGED], 0);
+ g_signal_emit (manager, ui_manager_signals[ACTIONS_CHANGED], 0);
}
/**
* gtk_ui_manager_get_action_groups:
- * @self: a #GtkUIManager object
+ * @manager: a #GtkUIManager object
*
- * Returns the list of action groups associated with @self.
+ * Returns the list of action groups associated with @manager.
*
* Return value: (element-type GtkActionGroup) (transfer none): a #GList of
* action groups. The list is owned by GTK+
* Since: 2.4
**/
GList *
-gtk_ui_manager_get_action_groups (GtkUIManager *self)
+gtk_ui_manager_get_action_groups (GtkUIManager *manager)
{
- g_return_val_if_fail (GTK_IS_UI_MANAGER (self), NULL);
+ g_return_val_if_fail (GTK_IS_UI_MANAGER (manager), NULL);
- return self->private_data->action_groups;
+ return manager->private_data->action_groups;
}
/**
* gtk_ui_manager_get_accel_group:
- * @self: a #GtkUIManager object
+ * @manager: a #GtkUIManager object
*
- * Returns the #GtkAccelGroup associated with @self.
+ * Returns the #GtkAccelGroup associated with @manager.
*
* Return value: (transfer none): the #GtkAccelGroup.
*
* Since: 2.4
**/
GtkAccelGroup *
-gtk_ui_manager_get_accel_group (GtkUIManager *self)
+gtk_ui_manager_get_accel_group (GtkUIManager *manager)
{
- g_return_val_if_fail (GTK_IS_UI_MANAGER (self), NULL);
+ g_return_val_if_fail (GTK_IS_UI_MANAGER (manager), NULL);
- return self->private_data->accel_group;
+ return manager->private_data->accel_group;
}
/**
* gtk_ui_manager_get_widget:
- * @self: a #GtkUIManager
+ * @manager: a #GtkUIManager
* @path: a path
*
* Looks up a widget by following a path.
* (e.g. "popup"). The root element ("/ui") can be omitted in the path.
*
* Note that the widget found by following a path that ends in a <menu>
- * element is the menuitem to which the menu is attached, not the menu itself.
+ * element is the menuitem to which the menu is attached, not the menu itmanager.
*
* Also note that the widgets constructed by a ui manager are not tied to
* the lifecycle of the ui manager. If you add the widgets returned by this
* Since: 2.4
**/
GtkWidget *
-gtk_ui_manager_get_widget (GtkUIManager *self,
+gtk_ui_manager_get_widget (GtkUIManager *manager,
const gchar *path)
{
- g_return_val_if_fail (GTK_IS_UI_MANAGER (self), NULL);
+ g_return_val_if_fail (GTK_IS_UI_MANAGER (manager), NULL);
g_return_val_if_fail (path != NULL, NULL);
- return GTK_UI_MANAGER_GET_CLASS (self)->get_widget (self, path);
+ return GTK_UI_MANAGER_GET_CLASS (manager)->get_widget (manager, path);
}
typedef struct {
/**
* gtk_ui_manager_get_toplevels:
- * @self: a #GtkUIManager
+ * @manager: a #GtkUIManager
* @types: specifies the types of toplevel widgets to include. Allowed
* types are #GTK_UI_MANAGER_MENUBAR, #GTK_UI_MANAGER_TOOLBAR and
* #GTK_UI_MANAGER_POPUP.
* Since: 2.4
**/
GSList *
-gtk_ui_manager_get_toplevels (GtkUIManager *self,
+gtk_ui_manager_get_toplevels (GtkUIManager *manager,
GtkUIManagerItemType types)
{
ToplevelData data;
- g_return_val_if_fail (GTK_IS_UI_MANAGER (self), NULL);
+ g_return_val_if_fail (GTK_IS_UI_MANAGER (manager), NULL);
g_return_val_if_fail ((~(GTK_UI_MANAGER_MENUBAR |
GTK_UI_MANAGER_TOOLBAR |
GTK_UI_MANAGER_POPUP) & types) == 0, NULL);
data.types = types;
data.list = NULL;
- g_node_children_foreach (self->private_data->root_node,
+ g_node_children_foreach (manager->private_data->root_node,
G_TRAVERSE_ALL,
collect_toplevels, &data);
/**
* gtk_ui_manager_get_action:
- * @self: a #GtkUIManager
+ * @manager: a #GtkUIManager
* @path: a path
*
* Looks up an action by following a path. See gtk_ui_manager_get_widget()
* for more information about paths.
*
- * Return value: the action whose proxy widget is found by following the path,
+ * Return value: (transfer none): the action whose proxy widget is found by following the path,
* or %NULL if no widget was found.
*
* Since: 2.4
**/
GtkAction *
-gtk_ui_manager_get_action (GtkUIManager *self,
+gtk_ui_manager_get_action (GtkUIManager *manager,
const gchar *path)
{
- g_return_val_if_fail (GTK_IS_UI_MANAGER (self), NULL);
+ g_return_val_if_fail (GTK_IS_UI_MANAGER (manager), NULL);
g_return_val_if_fail (path != NULL, NULL);
- return GTK_UI_MANAGER_GET_CLASS (self)->get_action (self, path);
+ return GTK_UI_MANAGER_GET_CLASS (manager)->get_action (manager, path);
}
static gboolean
}
static GNode *
-get_child_node (GtkUIManager *self,
+get_child_node (GtkUIManager *manager,
GNode *parent,
GNode *sibling,
const gchar *childname,
else
{
/* handle root node */
- if (self->private_data->root_node)
+ if (manager->private_data->root_node)
{
- child = self->private_data->root_node;
+ child = manager->private_data->root_node;
if (strncmp (NODE_INFO (child)->name, childname, childname_length) != 0)
g_warning ("root node name '%s' doesn't match '%s'",
childname, NODE_INFO (child)->name);
mnode->name = g_strndup (childname, childname_length);
mnode->dirty = TRUE;
- child = self->private_data->root_node = g_node_new (mnode);
+ child = manager->private_data->root_node = g_node_new (mnode);
}
}
}
static GNode *
-get_node (GtkUIManager *self,
+get_node (GtkUIManager *manager,
const gchar *path,
NodeType node_type,
gboolean create)
else
length = strlen (pos);
- node = get_child_node (self, parent, NULL, pos, length, NODE_TYPE_UNDECIDED,
+ node = get_child_node (manager, parent, NULL, pos, length, NODE_TYPE_UNDECIDED,
create, FALSE);
if (!node)
return NULL;
free_node (GNode *node)
{
Node *info = NODE_INFO (node);
-
- g_list_foreach (info->uifiles, (GFunc) node_ui_reference_free, NULL);
- g_list_free (info->uifiles);
- if (info->action)
- g_object_unref (info->action);
- if (info->proxy)
- g_object_unref (info->proxy);
- if (info->extra)
- g_object_unref (info->extra);
- g_free (info->name);
+ g_list_free_full (info->uifiles, node_ui_reference_free);
+ info->uifiles = NULL;
+
+ g_clear_object (&info->action);
+ g_clear_object (&info->proxy);
+ g_clear_object (&info->extra);
+ g_clear_pointer (&info->name, g_free);
g_slice_free (Node, info);
+ node->data = NULL;
return FALSE;
}
/**
* gtk_ui_manager_new_merge_id:
- * @self: a #GtkUIManager
+ * @manager: a #GtkUIManager
*
* Returns an unused merge id, suitable for use with
* gtk_ui_manager_add_ui().
* Since: 2.4
**/
guint
-gtk_ui_manager_new_merge_id (GtkUIManager *self)
+gtk_ui_manager_new_merge_id (GtkUIManager *manager)
{
- self->private_data->last_merge_id++;
+ manager->private_data->last_merge_id++;
- return self->private_data->last_merge_id;
+ return manager->private_data->last_merge_id;
}
static void
ParseState state;
ParseState prev_state;
- GtkUIManager *self;
+ GtkUIManager *manager;
GNode *current;
GError **error)
{
ParseContext *ctx = user_data;
- GtkUIManager *self = ctx->self;
+ GtkUIManager *manager = ctx->manager;
gint i;
const gchar *node_name;
if (ctx->state == STATE_ROOT && !strcmp (element_name, "accelerator"))
{
ctx->state = STATE_ACCELERATOR;
- ctx->current = get_child_node (self, ctx->current, NULL,
+ ctx->current = get_child_node (manager, ctx->current, NULL,
node_name, strlen (node_name),
NODE_TYPE_ACCELERATOR,
TRUE, FALSE);
if (ctx->state == STATE_START && !strcmp (element_name, "ui"))
{
ctx->state = STATE_ROOT;
- ctx->current = self->private_data->root_node;
+ ctx->current = manager->private_data->root_node;
raise_error = FALSE;
node_prepend_ui_reference (ctx->current, ctx->merge_id, action_quark);
if (ctx->state == STATE_ROOT && !strcmp (element_name, "menubar"))
{
ctx->state = STATE_MENU;
- ctx->current = get_child_node (self, ctx->current, NULL,
+ ctx->current = get_child_node (manager, ctx->current, NULL,
node_name, strlen (node_name),
NODE_TYPE_MENUBAR,
TRUE, FALSE);
}
else if (ctx->state == STATE_MENU && !strcmp (element_name, "menu"))
{
- ctx->current = get_child_node (self, ctx->current, NULL,
+ ctx->current = get_child_node (manager, ctx->current, NULL,
node_name, strlen (node_name),
NODE_TYPE_MENU,
TRUE, top);
{
ctx->state = STATE_MENU;
- ctx->current = get_child_node (self, g_node_last_child (ctx->current), NULL,
+ ctx->current = get_child_node (manager, g_node_last_child (ctx->current), NULL,
node_name, strlen (node_name),
NODE_TYPE_MENU,
TRUE, top);
GNode *node;
ctx->state = STATE_MENUITEM;
- node = get_child_node (self, ctx->current, NULL,
+ node = get_child_node (manager, ctx->current, NULL,
node_name, strlen (node_name),
NODE_TYPE_MENUITEM,
TRUE, top);
if (ctx->state == STATE_ROOT && !strcmp (element_name, "popup"))
{
ctx->state = STATE_MENU;
- ctx->current = get_child_node (self, ctx->current, NULL,
+ ctx->current = get_child_node (manager, ctx->current, NULL,
node_name, strlen (node_name),
NODE_TYPE_POPUP,
TRUE, FALSE);
!strcmp (element_name, "placeholder"))
{
if (ctx->state == STATE_TOOLBAR)
- ctx->current = get_child_node (self, ctx->current, NULL,
+ ctx->current = get_child_node (manager, ctx->current, NULL,
node_name, strlen (node_name),
NODE_TYPE_TOOLBAR_PLACEHOLDER,
TRUE, top);
else
- ctx->current = get_child_node (self, ctx->current, NULL,
+ ctx->current = get_child_node (manager, ctx->current, NULL,
node_name, strlen (node_name),
NODE_TYPE_MENU_PLACEHOLDER,
TRUE, top);
}
else
length = strlen (node_name);
- node = get_child_node (self, ctx->current, NULL,
+ node = get_child_node (manager, ctx->current, NULL,
node_name, length,
NODE_TYPE_SEPARATOR,
TRUE, top);
if (ctx->state == STATE_ROOT && !strcmp (element_name, "toolbar"))
{
ctx->state = STATE_TOOLBAR;
- ctx->current = get_child_node (self, ctx->current, NULL,
+ ctx->current = get_child_node (manager, ctx->current, NULL,
node_name, strlen (node_name),
NODE_TYPE_TOOLBAR,
TRUE, FALSE);
GNode *node;
ctx->state = STATE_TOOLITEM;
- node = get_child_node (self, ctx->current, NULL,
+ node = get_child_node (manager, ctx->current, NULL,
node_name, strlen (node_name),
NODE_TYPE_TOOLITEM,
TRUE, top);
/* should also walk through the tree and get rid of nodes related to
* this UI file's tag */
- gtk_ui_manager_remove_ui (ctx->self, ctx->merge_id);
+ gtk_ui_manager_remove_ui (ctx->manager, ctx->merge_id);
}
static gboolean
};
static guint
-add_ui_from_string (GtkUIManager *self,
+add_ui_from_string (GtkUIManager *manager,
const gchar *buffer,
gssize length,
gboolean needs_root,
GMarkupParseContext *context;
ctx.state = STATE_START;
- ctx.self = self;
+ ctx.manager = manager;
ctx.current = NULL;
- ctx.merge_id = gtk_ui_manager_new_merge_id (self);
+ ctx.merge_id = gtk_ui_manager_new_merge_id (manager);
context = g_markup_parse_context_new (&ui_parser, 0, &ctx, NULL);
g_markup_parse_context_free (context);
- queue_update (self);
+ queue_update (manager);
- g_object_notify (G_OBJECT (self), "ui");
+ g_object_notify (G_OBJECT (manager), "ui");
return ctx.merge_id;
/**
* gtk_ui_manager_add_ui_from_string:
- * @self: a #GtkUIManager object
+ * @manager: a #GtkUIManager object
* @buffer: the string to parse
* @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
* @error: return location for an error
*
* Parses a string containing a <link linkend="XML-UI">UI definition</link> and
- * merges it with the current contents of @self. An enclosing <ui>
+ * merges it with the current contents of @manager. An enclosing <ui>
* element is added if it is missing.
*
* Return value: The merge id for the merged UI. The merge id can be used
* Since: 2.4
**/
guint
-gtk_ui_manager_add_ui_from_string (GtkUIManager *self,
+gtk_ui_manager_add_ui_from_string (GtkUIManager *manager,
const gchar *buffer,
gssize length,
GError **error)
const gchar *p;
const gchar *end;
- g_return_val_if_fail (GTK_IS_UI_MANAGER (self), 0);
+ g_return_val_if_fail (GTK_IS_UI_MANAGER (manager), 0);
g_return_val_if_fail (buffer != NULL, 0);
if (length < 0)
if (end - p >= 4 && strncmp (p, "<ui>", 4) == 0)
needs_root = FALSE;
- return add_ui_from_string (self, buffer, length, needs_root, error);
+ return add_ui_from_string (manager, buffer, length, needs_root, error);
}
/**
* gtk_ui_manager_add_ui_from_file:
- * @self: a #GtkUIManager object
- * @filename: the name of the file to parse
+ * @manager: a #GtkUIManager object
+ * @filename: (type filename): the name of the file to parse
* @error: return location for an error
*
* Parses a file containing a <link linkend="XML-UI">UI definition</link> and
- * merges it with the current contents of @self.
+ * merges it with the current contents of @manager.
*
* Return value: The merge id for the merged UI. The merge id can be used
* to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred,
* Since: 2.4
**/
guint
-gtk_ui_manager_add_ui_from_file (GtkUIManager *self,
+gtk_ui_manager_add_ui_from_file (GtkUIManager *manager,
const gchar *filename,
GError **error)
{
gsize length;
guint res;
- g_return_val_if_fail (GTK_IS_UI_MANAGER (self), 0);
+ g_return_val_if_fail (GTK_IS_UI_MANAGER (manager), 0);
if (!g_file_get_contents (filename, &buffer, &length, error))
return 0;
- res = add_ui_from_string (self, buffer, length, FALSE, error);
+ res = add_ui_from_string (manager, buffer, length, FALSE, error);
g_free (buffer);
return res;
}
+/**
+ * gtk_ui_manager_add_ui_from_resource:
+ * @manager: a #GtkUIManager object
+ * @resource_path: the resource path of the file to parse
+ * @error: return location for an error
+ *
+ * Parses a resource file containing a <link linkend="XML-UI">UI definition</link> and
+ * merges it with the current contents of @manager.
+ *
+ * Return value: The merge id for the merged UI. The merge id can be used
+ * to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred,
+ * the return value is 0.
+ *
+ * Since: 3.4
+ **/
+guint
+gtk_ui_manager_add_ui_from_resource (GtkUIManager *manager,
+ const gchar *resource_path,
+ GError **error)
+{
+ GBytes *data;
+ guint res;
+
+ g_return_val_if_fail (GTK_IS_UI_MANAGER (manager), 0);
+
+ data = g_resources_lookup_data (resource_path, 0, error);
+ if (data == NULL)
+ return 0;
+
+ res = add_ui_from_string (manager, g_bytes_get_data (data, NULL), g_bytes_get_size (data), FALSE, error);
+ g_bytes_unref (data);
+
+ return res;
+}
+
/**
* gtk_ui_manager_add_ui:
- * @self: a #GtkUIManager
+ * @manager: a #GtkUIManager
* @merge_id: the merge id for the merged UI, see gtk_ui_manager_new_merge_id()
* @path: a path
* @name: the name for the added UI element
* @top: if %TRUE, the UI element is added before its siblings, otherwise it
* is added after its siblings.
*
- * Adds a UI element to the current contents of @self.
+ * Adds a UI element to the current contents of @manager.
*
* If @type is %GTK_UI_MANAGER_AUTO, GTK+ inserts a menuitem, toolitem or
* separator if such an element can be inserted at the place determined by
* Since: 2.4
**/
void
-gtk_ui_manager_add_ui (GtkUIManager *self,
+gtk_ui_manager_add_ui (GtkUIManager *manager,
guint merge_id,
const gchar *path,
const gchar *name,
NodeType node_type;
GQuark action_quark = 0;
- g_return_if_fail (GTK_IS_UI_MANAGER (self));
+ g_return_if_fail (GTK_IS_UI_MANAGER (manager));
g_return_if_fail (merge_id > 0);
g_return_if_fail (name != NULL || type == GTK_UI_MANAGER_SEPARATOR);
- node = get_node (self, path, NODE_TYPE_UNDECIDED, FALSE);
+ node = get_node (manager, path, NODE_TYPE_UNDECIDED, FALSE);
sibling = NULL;
if (node == NULL)
return;
}
- child = get_child_node (self, node, sibling,
+ child = get_child_node (manager, node, sibling,
name, name ? strlen (name) : 0,
node_type, TRUE, top);
if (NODE_INFO (child)->action_name == 0)
NODE_INFO (child)->action_name = action_quark;
- queue_update (self);
+ queue_update (manager);
- g_object_notify (G_OBJECT (self), "ui");
+ g_object_notify (G_OBJECT (manager), "ui");
}
static gboolean
/**
* gtk_ui_manager_remove_ui:
- * @self: a #GtkUIManager object
+ * @manager: a #GtkUIManager object
* @merge_id: a merge id as returned by gtk_ui_manager_add_ui_from_string()
*
- * Unmerges the part of @self<!-- -->s content identified by @merge_id.
+ * Unmerges the part of @manager<!-- -->s content identified by @merge_id.
*
* Since: 2.4
**/
void
-gtk_ui_manager_remove_ui (GtkUIManager *self,
+gtk_ui_manager_remove_ui (GtkUIManager *manager,
guint merge_id)
{
- g_return_if_fail (GTK_IS_UI_MANAGER (self));
+ g_return_if_fail (GTK_IS_UI_MANAGER (manager));
- g_node_traverse (self->private_data->root_node,
+ g_node_traverse (manager->private_data->root_node,
G_POST_ORDER, G_TRAVERSE_ALL, -1,
remove_ui, GUINT_TO_POINTER (merge_id));
- queue_update (self);
+ queue_update (manager);
- g_object_notify (G_OBJECT (self), "ui");
+ g_object_notify (G_OBJECT (manager), "ui");
}
/* -------------------- Updates -------------------- */
}
static gboolean
-find_menu_position (GNode *node,
- GtkWidget **menushell_p,
- gint *pos_p)
+find_menu_position (GNode *node,
+ GtkWidget **menushell_p,
+ gint *pos_p)
{
GtkWidget *menushell;
gint pos = 0;
case NODE_TYPE_MENU_PLACEHOLDER:
menushell = gtk_widget_get_parent (NODE_INFO (parent)->proxy);
g_return_val_if_fail (GTK_IS_MENU_SHELL (menushell), FALSE);
- pos = g_list_index (GTK_MENU_SHELL (menushell)->children,
+ pos = g_list_index (GTK_MENU_SHELL (menushell)->priv->children,
NODE_INFO (parent)->proxy) + 1;
break;
default:
if (!GTK_IS_MENU_SHELL (menushell))
return FALSE;
- pos = g_list_index (GTK_MENU_SHELL (menushell)->children, prev_child) + 1;
+ pos = g_list_index (GTK_MENU_SHELL (menushell)->priv->children, prev_child) + 1;
}
if (menushell_p)
return TRUE;
}
-/**
- * _gtk_menu_is_empty:
- * @menu: (allow-none): a #GtkMenu or %NULL
- *
- * Determines whether @menu is empty. A menu is considered empty if it
- * the only visible children are tearoff menu items or "filler" menu
- * items which were inserted to mark the menu as empty.
- *
- * This function is used by #GtkAction.
- *
- * Return value: whether @menu is empty.
- **/
-gboolean
-_gtk_menu_is_empty (GtkWidget *menu)
-{
- GList *children, *cur;
- gboolean result = TRUE;
-
- g_return_val_if_fail (menu == NULL || GTK_IS_MENU (menu), TRUE);
-
- if (!menu)
- return FALSE;
-
- children = gtk_container_get_children (GTK_CONTAINER (menu));
-
- cur = children;
- while (cur)
- {
- if (gtk_widget_get_visible (cur->data))
- {
- if (!GTK_IS_TEAROFF_MENU_ITEM (cur->data) &&
- !g_object_get_data (cur->data, "gtk-empty-menu-item"))
- {
- result = FALSE;
- break;
- }
- }
- cur = cur->next;
- }
- g_list_free (children);
-
- return result;
-}
-
enum {
SEPARATOR_MODE_SMART,
SEPARATOR_MODE_VISIBLE,
}
static void
-update_node (GtkUIManager *self,
+update_node (GtkUIManager *manager,
GNode *node,
gboolean in_popup,
gboolean popup_accels)
ref = info->uifiles->data;
action_name = g_quark_to_string (ref->action_quark);
- action = get_action_by_name (self, action_name);
+ action = get_action_by_name (manager, action_name);
info->dirty = FALSE;
}
if (action)
- gtk_action_set_accel_group (action, self->private_data->accel_group);
+ gtk_action_set_accel_group (action, manager->private_data->accel_group);
/* If the widget already has a proxy and the action hasn't changed, then
* we only have to update the tearoff menu items.
siblings = gtk_container_get_children (GTK_CONTAINER (menu));
if (siblings != NULL && GTK_IS_TEAROFF_MENU_ITEM (siblings->data))
{
- if (self->private_data->add_tearoffs && !in_popup)
+ if (manager->private_data->add_tearoffs && !in_popup)
gtk_widget_show (GTK_WIDGET (siblings->data));
else
gtk_widget_hide (GTK_WIDGET (siblings->data));
g_object_ref_sink (info->proxy);
gtk_widget_set_name (info->proxy, info->name);
gtk_widget_show (info->proxy);
- g_signal_emit (self, ui_manager_signals[ADD_WIDGET], 0, info->proxy);
+ g_signal_emit (manager, ui_manager_signals[ADD_WIDGET], 0, info->proxy);
}
break;
case NODE_TYPE_POPUP:
}
gtk_activatable_set_related_action (GTK_ACTIVATABLE (info->proxy), NULL);
- gtk_container_remove (GTK_CONTAINER (info->proxy->parent),
+ gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (info->proxy)),
info->proxy);
g_object_unref (info->proxy);
info->proxy = NULL;
siblings = gtk_container_get_children (GTK_CONTAINER (menu));
if (siblings != NULL && GTK_IS_TEAROFF_MENU_ITEM (siblings->data))
{
- if (self->private_data->add_tearoffs && !in_popup)
+ if (manager->private_data->add_tearoffs && !in_popup)
gtk_widget_show (GTK_WIDGET (siblings->data));
else
gtk_widget_hide (GTK_WIDGET (siblings->data));
g_object_ref_sink (info->proxy);
gtk_widget_set_name (info->proxy, info->name);
gtk_widget_show (info->proxy);
- g_signal_emit (self, ui_manager_signals[ADD_WIDGET], 0, info->proxy);
+ g_signal_emit (manager, ui_manager_signals[ADD_WIDGET], 0, info->proxy);
}
break;
case NODE_TYPE_MENU_PLACEHOLDER:
{
if (info->proxy)
{
- gtk_container_remove (GTK_CONTAINER (info->proxy->parent),
+ gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (info->proxy)),
info->proxy);
g_object_unref (info->proxy);
info->proxy = NULL;
}
if (info->extra)
{
- gtk_container_remove (GTK_CONTAINER (info->extra->parent),
+ gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (info->extra)),
info->extra);
g_object_unref (info->extra);
info->extra = NULL;
{
if (info->proxy)
{
- gtk_container_remove (GTK_CONTAINER (info->proxy->parent),
+ gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (info->proxy)),
info->proxy);
g_object_unref (info->proxy);
info->proxy = NULL;
}
if (info->extra)
{
- gtk_container_remove (GTK_CONTAINER (info->extra->parent),
+ gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (info->extra)),
info->extra);
g_object_unref (info->extra);
info->extra = NULL;
G_CALLBACK (update_smart_separators),
NULL);
gtk_activatable_set_related_action (GTK_ACTIVATABLE (info->proxy), NULL);
- gtk_container_remove (GTK_CONTAINER (info->proxy->parent),
+ gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (info->proxy)),
info->proxy);
g_object_unref (info->proxy);
info->proxy = NULL;
G_CALLBACK (update_smart_separators),
NULL);
gtk_activatable_set_related_action (GTK_ACTIVATABLE (info->proxy), NULL);
- gtk_container_remove (GTK_CONTAINER (info->proxy->parent),
+ gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (info->proxy)),
info->proxy);
g_object_unref (info->proxy);
info->proxy = NULL;
if (GTK_IS_SEPARATOR_TOOL_ITEM (info->proxy))
{
- gtk_container_remove (GTK_CONTAINER (info->proxy->parent),
+ gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (info->proxy)),
info->proxy);
g_object_unref (info->proxy);
info->proxy = NULL;
if (GTK_IS_SEPARATOR_MENU_ITEM (info->proxy))
{
- gtk_container_remove (GTK_CONTAINER (info->proxy->parent),
+ gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (info->proxy)),
info->proxy);
g_object_unref (info->proxy);
info->proxy = NULL;
current = child;
child = current->next;
- update_node (self, current, in_popup, popup_accels);
+ update_node (manager, current, in_popup, popup_accels);
}
if (info->proxy)
}
static gboolean
-do_updates (GtkUIManager *self)
+do_updates (GtkUIManager *manager)
{
/* this function needs to check through the tree for dirty nodes.
* For such nodes, it needs to do the following:
* the proxy is reconnected to the new action (or a new proxy widget
* is created and added to the parent container).
*/
- update_node (self, self->private_data->root_node, FALSE, FALSE);
+ update_node (manager, manager->private_data->root_node, FALSE, FALSE);
- self->private_data->update_tag = 0;
+ manager->private_data->update_tag = 0;
return FALSE;
}
static gboolean
-do_updates_idle (GtkUIManager *self)
+do_updates_idle (GtkUIManager *manager)
{
- do_updates (self);
+ do_updates (manager);
return FALSE;
}
static void
-queue_update (GtkUIManager *self)
+queue_update (GtkUIManager *manager)
{
- if (self->private_data->update_tag != 0)
+ if (manager->private_data->update_tag != 0)
return;
- self->private_data->update_tag = gdk_threads_add_idle (
+ manager->private_data->update_tag = gdk_threads_add_idle (
(GSourceFunc)do_updates_idle,
- self);
+ manager);
}
/**
* gtk_ui_manager_ensure_update:
- * @self: a #GtkUIManager
+ * @manager: a #GtkUIManager
*
* Makes sure that all pending updates to the UI have been completed.
*
* Since: 2.4
**/
void
-gtk_ui_manager_ensure_update (GtkUIManager *self)
+gtk_ui_manager_ensure_update (GtkUIManager *manager)
{
- if (self->private_data->update_tag != 0)
+ if (manager->private_data->update_tag != 0)
{
- g_source_remove (self->private_data->update_tag);
- do_updates (self);
+ g_source_remove (manager->private_data->update_tag);
+ do_updates (manager);
}
}
}
static void
-dirty_all_nodes (GtkUIManager *self)
+dirty_all_nodes (GtkUIManager *manager)
{
- g_node_traverse (self->private_data->root_node,
+ g_node_traverse (manager->private_data->root_node,
G_PRE_ORDER, G_TRAVERSE_ALL, -1,
dirty_traverse_func, NULL);
- queue_update (self);
+ queue_update (manager);
}
static void
}
static void
-print_node (GtkUIManager *self,
+print_node (GtkUIManager *manager,
GNode *node,
gint indent_level,
GString *buffer)
g_string_append (buffer, close_fmt ? ">\n" : "/>\n");
for (child = node->children; child != NULL; child = child->next)
- print_node (self, child, indent_level + 2, buffer);
+ print_node (manager, child, indent_level + 2, buffer);
if (close_fmt)
g_string_append_printf (buffer, close_fmt, indent_level, "");
ctx = g_new0 (ParseContext, 1);
ctx->state = STATE_START;
- ctx->self = GTK_UI_MANAGER (buildable);
+ ctx->manager = GTK_UI_MANAGER (buildable);
ctx->current = NULL;
ctx->merge_id = gtk_ui_manager_new_merge_id (GTK_UI_MANAGER (buildable));
/**
* gtk_ui_manager_get_ui:
- * @self: a #GtkUIManager
+ * @manager: a #GtkUIManager
*
* Creates a <link linkend="XML-UI">UI definition</link> of the merged UI.
*
* Since: 2.4
**/
gchar *
-gtk_ui_manager_get_ui (GtkUIManager *self)
+gtk_ui_manager_get_ui (GtkUIManager *manager)
{
GString *buffer;
buffer = g_string_new (NULL);
- gtk_ui_manager_ensure_update (self);
+ gtk_ui_manager_ensure_update (manager);
- print_node (self, self->private_data->root_node, 0, buffer);
+ print_node (manager, manager->private_data->root_node, 0, buffer);
return g_string_free (buffer, FALSE);
}
-
-#if defined (G_OS_WIN32) && !defined (_WIN64)
-
-#undef gtk_ui_manager_add_ui_from_file
-
-guint
-gtk_ui_manager_add_ui_from_file (GtkUIManager *self,
- const gchar *filename,
- GError **error)
-{
- gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, error);
- guint retval;
-
- if (utf8_filename == NULL)
- return 0;
-
- retval = gtk_ui_manager_add_ui_from_file_utf8 (self, utf8_filename, error);
-
- g_free (utf8_filename);
-
- return retval;
-}
-
-#endif
projects / ~andy / gtk / blobdiff