2 * Copyright © 2011 Canonical Ltd.
4 * This library is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as
6 * published by the Free Software Foundation; either version 2 of the
7 * licence, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
19 * Author: Ryan Lortie <desrt@desrt.ca>
22 #include "gmenumodel.h"
27 * @short_description: An abstract class representing the contents of a menu
28 * @see_also: #GActionGroup
30 * #GMenuModel represents the contents of a menu -- an ordered list of
31 * menu items. The items are associated with actions, which can be
32 * activated through them. Items can be grouped in sections, and may
33 * have submenus associated with them. Both items and sections usually
34 * have some representation data, such as labels or icons. The type of
35 * the associated action (ie whether it is stateful, and what kind of
36 * state it has) can influence the representation of the item.
38 * The conceptual model of menus in #GMenuModel is hierarchical:
39 * sections and submenus are again represented by #GMenuModels.
40 * Menus themselves do not define their own roles. Rather, the role
41 * of a particular #GMenuModel is defined by the item that references
42 * it (or, in the case of the 'root' menu, is defined by the context
43 * in which it is used).
45 * As an example, consider the visible portions of the menu in
46 * <xref linkend="menu-example"/>.
48 * <figure id="menu-example">
49 * <title>An example menu</title>
50 * <graphic fileref="menu-example.png" format="PNG"></graphic>
53 * There are 8 "menus" visible in the screenshot: one menubar, two
54 * submenus and 5 sections:
56 * <listitem>the toplevel menubar (containing 4 items)</listitem>
57 * <listitem>the View submenu (containing 3 sections)</listitem>
58 * <listitem>the first section of the View submenu (containing 2 items)</listitem>
59 * <listitem>the second section of the View submenu (containing 1 item)</listitem>
60 * <listitem>the final section of the View submenu (containing 1 item)</listitem>
61 * <listitem>the Highlight Mode submenu (containing 2 sections)</listitem>
62 * <listitem>the Sources section (containing 2 items)</listitem>
63 * <listitem>the Markup section (containing 2 items)</listitem>
66 * <xref linkend="menu-model"/> illustrates the conceptual connection between
67 * these 8 menus. Each large block in the figure represents a menu and the
68 * smaller blocks within the large block represent items in that menu. Some
69 * items contain references to other menus.
71 * <figure id="menu-model">
72 * <title>A menu model</title>
73 * <graphic fileref="menu-model.png" format="PNG"></graphic>
76 * Notice that the separators visible in <xref linkend="menu-example"/>
77 * appear nowhere in <xref linkend="menu-model"/>. This is because
78 * separators are not explicitly represented in the menu model. Instead,
79 * a separator is inserted between any two non-empty sections of a menu.
80 * Section items can have labels just like any other item. In that case,
81 * a display system may show a section header instead of a separator.
83 * The motivation for this abstract model of application controls is
84 * that modern user interfaces tend to make these controls available
85 * outside the application. Examples include global menus, jumplists,
86 * dash boards, etc. To support such uses, it is necessary to 'export'
87 * information about actions and their representation in menus, which
89 * <link linkend="gio-GActionGroup-exporter">GActionGroup exporter</link>
91 * <link linkend="gio-GMenuModel-exporter">GMenuModel exporter</link>
92 * do for #GActionGroup and #GMenuModel. The client-side counterparts
93 * to make use of the exported information are #GDBusActionGroup and
96 * The API of #GMenuModel is very generic, with iterators for the
97 * attributes and links of an item, see g_menu_model_iterate_item_attributes()
98 * and g_menu_model_iterate_item_links(). The 'standard' attributes and
99 * link types have predefined names: %G_MENU_ATTRIBUTE_LABEL,
100 * %G_MENU_ATTRIBUTE_ACTION, %G_MENU_ATTRIBUTE_TARGET, %G_MENU_LINK_SECTION
101 * and %G_MENU_LINK_SUBMENU.
103 * FIXME: explain how items are associated with actions.
105 * While a wide variety of stateful actions is possible, the following
106 * is the minimum that is expected to be supported by all users of exported
109 * <listitem>an action with no parameter type and no state</listitem>
110 * <listitem>an action with no parameter type and boolean state</listitem>
111 * <listitem>an action with string parameter type and string state</listitem>
114 * <formalpara><title>Stateless</title>
116 * A stateless action typically corresponds to an ordinary menu item.
119 * Selecting such a menu item will activate the action (with no parameter).
123 * <formalpara><title>Boolean State</title>
125 * An action with a boolean state will most typically be used with a "toggle"
126 * or "switch" menu item. The state can be set directly, but activating the
127 * action (with no parameter) results in the state being toggled.
130 * Selecting a toggle menu item will activate the action. The menu item should
131 * be rendered as "checked" when the state is true.
135 * <formalpara><title>String Parameter and State</title>
137 * Actions with string parameters and state will most typically be used to
138 * represent an enumerated choice over the items available for a group of
139 * radio menu items. Activating the action with a string parameter is
140 * equivalent to setting that parameter as the state.
143 * Radio menu items, in addition to being associated with the action, will
144 * have a target value. Selecting that menu item will result in activation
145 * of the action with the target value as the parameter. The menu item should
146 * be rendered as "selected" when the state of the action is equal to the
147 * target value of the menu item.
155 * #GMenuModel is an opaque structure type. You must access it using the
162 * GMenuAttributeIter:
164 * #GMenuAttributeIter is an opaque structure type. You must access it
165 * using the functions below.
173 * #GMenuLinkIter is an opaque structure type. You must access it using
174 * the functions below.
181 GMenuLinkIter parent_instance
;
186 typedef GMenuLinkIterClass GMenuLinkHashIterClass
;
188 G_DEFINE_TYPE (GMenuLinkHashIter
, g_menu_link_hash_iter
, G_TYPE_MENU_LINK_ITER
)
191 g_menu_link_hash_iter_get_next (GMenuLinkIter
*link_iter
,
192 const gchar
**out_name
,
195 GMenuLinkHashIter
*iter
= (GMenuLinkHashIter
*) link_iter
;
196 gpointer keyptr
, valueptr
;
198 if (!g_hash_table_iter_next (&iter
->iter
, &keyptr
, &valueptr
))
202 *value
= g_object_ref (valueptr
);
208 g_menu_link_hash_iter_finalize (GObject
*object
)
210 GMenuLinkHashIter
*iter
= (GMenuLinkHashIter
*) object
;
212 g_hash_table_unref (iter
->table
);
214 G_OBJECT_CLASS (g_menu_link_hash_iter_parent_class
)
219 g_menu_link_hash_iter_init (GMenuLinkHashIter
*iter
)
224 g_menu_link_hash_iter_class_init (GMenuLinkHashIterClass
*class)
226 GObjectClass
*object_class
= G_OBJECT_CLASS (class);
228 object_class
->finalize
= g_menu_link_hash_iter_finalize
;
229 class->get_next
= g_menu_link_hash_iter_get_next
;
235 GMenuAttributeIter parent_instance
;
238 } GMenuAttributeHashIter
;
240 typedef GMenuAttributeIterClass GMenuAttributeHashIterClass
;
242 G_DEFINE_TYPE (GMenuAttributeHashIter
, g_menu_attribute_hash_iter
, G_TYPE_MENU_ATTRIBUTE_ITER
)
245 g_menu_attribute_hash_iter_get_next (GMenuAttributeIter
*attr_iter
,
249 GMenuAttributeHashIter
*iter
= (GMenuAttributeHashIter
*) attr_iter
;
250 gpointer keyptr
, valueptr
;
252 if (!g_hash_table_iter_next (&iter
->iter
, &keyptr
, &valueptr
))
257 *value
= g_variant_ref (valueptr
);
263 g_menu_attribute_hash_iter_finalize (GObject
*object
)
265 GMenuAttributeHashIter
*iter
= (GMenuAttributeHashIter
*) object
;
267 g_hash_table_unref (iter
->table
);
269 G_OBJECT_CLASS (g_menu_attribute_hash_iter_parent_class
)
274 g_menu_attribute_hash_iter_init (GMenuAttributeHashIter
*iter
)
279 g_menu_attribute_hash_iter_class_init (GMenuAttributeHashIterClass
*class)
281 GObjectClass
*object_class
= G_OBJECT_CLASS (class);
283 object_class
->finalize
= g_menu_attribute_hash_iter_finalize
;
284 class->get_next
= g_menu_attribute_hash_iter_get_next
;
287 G_DEFINE_ABSTRACT_TYPE (GMenuModel
, g_menu_model
, G_TYPE_OBJECT
)
290 guint g_menu_model_items_changed_signal
;
292 static GMenuAttributeIter
*
293 g_menu_model_real_iterate_item_attributes (GMenuModel
*model
,
296 GHashTable
*table
= NULL
;
297 GMenuAttributeIter
*result
;
299 G_MENU_MODEL_GET_CLASS (model
)->get_item_attributes (model
, item_index
, &table
);
303 GMenuAttributeHashIter
*iter
= g_object_new (g_menu_attribute_hash_iter_get_type (), NULL
);
304 g_hash_table_iter_init (&iter
->iter
, table
);
305 iter
->table
= g_hash_table_ref (table
);
306 result
= G_MENU_ATTRIBUTE_ITER (iter
);
310 g_critical ("GMenuModel implementation '%s' doesn't override iterate_item_attributes() "
311 "and fails to return sane values from get_item_attributes()",
312 G_OBJECT_TYPE_NAME (model
));
317 g_hash_table_unref (table
);
323 g_menu_model_real_get_item_attribute_value (GMenuModel
*model
,
325 const gchar
*attribute
,
326 const GVariantType
*expected_type
)
328 GHashTable
*table
= NULL
;
329 GVariant
*value
= NULL
;
331 G_MENU_MODEL_GET_CLASS (model
)
332 ->get_item_attributes (model
, item_index
, &table
);
336 value
= g_hash_table_lookup (table
, attribute
);
340 if (expected_type
== NULL
|| g_variant_is_of_type (value
, expected_type
))
341 value
= g_variant_ref (value
);
347 g_assert_not_reached ();
350 g_hash_table_unref (table
);
355 static GMenuLinkIter
*
356 g_menu_model_real_iterate_item_links (GMenuModel
*model
,
359 GHashTable
*table
= NULL
;
360 GMenuLinkIter
*result
;
362 G_MENU_MODEL_GET_CLASS (model
)
363 ->get_item_links (model
, item_index
, &table
);
367 GMenuLinkHashIter
*iter
= g_object_new (g_menu_link_hash_iter_get_type (), NULL
);
368 g_hash_table_iter_init (&iter
->iter
, table
);
369 iter
->table
= g_hash_table_ref (table
);
370 result
= G_MENU_LINK_ITER (iter
);
374 g_critical ("GMenuModel implementation '%s' doesn't override iterate_item_links() "
375 "and fails to return sane values from get_item_links()",
376 G_OBJECT_TYPE_NAME (model
));
381 g_hash_table_unref (table
);
387 g_menu_model_real_get_item_link (GMenuModel
*model
,
391 GHashTable
*table
= NULL
;
392 GMenuModel
*value
= NULL
;
394 G_MENU_MODEL_GET_CLASS (model
)
395 ->get_item_links (model
, item_index
, &table
);
398 value
= g_hash_table_lookup (table
, link
);
400 g_assert_not_reached ();
403 g_object_ref (value
);
406 g_hash_table_unref (table
);
412 g_menu_model_init (GMenuModel
*model
)
417 g_menu_model_class_init (GMenuModelClass
*class)
419 class->iterate_item_attributes
= g_menu_model_real_iterate_item_attributes
;
420 class->get_item_attribute_value
= g_menu_model_real_get_item_attribute_value
;
421 class->iterate_item_links
= g_menu_model_real_iterate_item_links
;
422 class->get_item_link
= g_menu_model_real_get_item_link
;
425 * GMenuModel::items-changed:
426 * @model: the #GMenuModel that is changing
427 * @position: the position of the change
428 * @removed: the number of items removed
429 * @added: the number of items added
431 * Emitted when a change has occured to the menu.
433 * The only changes that can occur to a menu is that items are removed
434 * or added. Items may not change (except by being removed and added
435 * back in the same location). This signal is capable of describing
436 * both of those changes (at the same time).
438 * The signal means that starting at the index @position, @removed
439 * items were removed and @added items were added in their place. If
440 * @removed is zero then only items were added. If @added is zero
441 * then only items were removed.
443 * As an example, if the menu contains items a, b, c, d (in that
444 * order) and the signal (2, 1, 3) occurs then the new composition of
445 * the menu will be a, b, _, _, _, d (with each _ representing some
448 * Signal handlers may query the model (particularly the added items)
449 * and expect to see the results of the modification that is being
450 * reported. The signal is emitted after the modification.
452 g_menu_model_items_changed_signal
=
453 g_signal_new ("items-changed", G_TYPE_MENU_MODEL
,
454 G_SIGNAL_RUN_LAST
, 0, NULL
, NULL
,
455 g_cclosure_marshal_generic
, G_TYPE_NONE
,
456 3, G_TYPE_INT
, G_TYPE_INT
, G_TYPE_INT
);
460 * g_menu_model_is_mutable:
461 * @model: a #GMenuModel
463 * Queries if @model is mutable.
465 * An immutable #GMenuModel will never emit the #GMenuModel::items-changed
466 * signal. Consumers of the model may make optimisations accordingly.
468 * Returns: %TRUE if the model is mutable (ie: "items-changed" may be
474 g_menu_model_is_mutable (GMenuModel
*model
)
476 return G_MENU_MODEL_GET_CLASS (model
)
477 ->is_mutable (model
);
481 * g_menu_model_get_n_items:
482 * @model: a #GMenuModel
484 * Query the number of items in @model.
486 * Returns: the number of items
491 g_menu_model_get_n_items (GMenuModel
*model
)
493 return G_MENU_MODEL_GET_CLASS (model
)
494 ->get_n_items (model
);
498 * g_menu_model_iterate_item_attributes:
499 * @model: a #GMenuModel
500 * @item_index: the index of the item
502 * Creates a #GMenuAttributeIter to iterate over the attributes of
503 * the item at position @item_index in @model.
505 * You must free the iterator with g_object_unref() when you are done.
507 * Returns: (transfer full): a new #GMenuAttributeIter
512 g_menu_model_iterate_item_attributes (GMenuModel
*model
,
515 return G_MENU_MODEL_GET_CLASS (model
)
516 ->iterate_item_attributes (model
, item_index
);
520 * g_menu_model_get_item_attribute_value:
521 * @model: a #GMenuModel
522 * @item_index: the index of the item
523 * @attribute: the attribute to query
524 * @expected_type: (allow-none): the expected type of the attribute, or
527 * Queries the item at position @item_index in @model for the attribute
528 * specified by @attribute.
530 * If @expected_type is non-%NULL then it specifies the expected type of
531 * the attribute. If it is %NULL then any type will be accepted.
533 * If the attribute exists and matches @expected_type (or if the
534 * expected type is unspecified) then the value is returned.
536 * If the attribute does not exist, or does not match the expected type
537 * then %NULL is returned.
539 * Returns: (transfer full): the value of the attribute
544 g_menu_model_get_item_attribute_value (GMenuModel
*model
,
546 const gchar
*attribute
,
547 const GVariantType
*expected_type
)
549 return G_MENU_MODEL_GET_CLASS (model
)
550 ->get_item_attribute_value (model
, item_index
, attribute
, expected_type
);
554 * g_menu_model_get_item_attribute:
555 * @model: a #GMenuModel
556 * @item_index: the index of the item
557 * @attribute: the attribute to query
558 * @format_string: a #GVariant format string
559 * @...: positional parameters, as per @format_string
561 * Queries item at position @item_index in @model for the attribute
562 * specified by @attribute.
564 * If the attribute exists and matches the #GVariantType corresponding
565 * to @format_string then @format_string is used to deconstruct the
566 * value into the positional parameters and %TRUE is returned.
568 * If the attribute does not exist, or it does exist but has the wrong
569 * type, then the positional parameters are ignored and %FALSE is
572 * Returns: %TRUE if the named attribute was found with the expected
578 g_menu_model_get_item_attribute (GMenuModel
*model
,
580 const gchar
*attribute
,
581 const gchar
*format_string
,
584 const GVariantType
*expected_type
;
588 expected_type
= NULL
; /* XXX devine the type, ensure no '&' */
590 value
= g_menu_model_get_item_attribute_value (model
, item_index
, attribute
, expected_type
);
594 va_start (ap
, format_string
);
595 g_variant_get_va (value
, format_string
, NULL
, &ap
);
596 g_variant_unref (value
);
603 * g_menu_model_iterate_item_links:
604 * @model: a #GMenuModel
605 * @item_index: the index of the item
607 * Creates a #GMenuLinkIter to iterate over the links of the item at
608 * position @item_index in @model.
610 * You must free the iterator with g_object_unref() when you are done.
612 * Returns: (transfer full): a new #GMenuLinkIter
617 g_menu_model_iterate_item_links (GMenuModel
*model
,
620 return G_MENU_MODEL_GET_CLASS (model
)
621 ->iterate_item_links (model
, item_index
);
625 * g_menu_model_get_item_link:
626 * @model: a #GMenuModel
627 * @item_index: the index of the item
628 * @link: the link to query
630 * Queries the item at position @item_index in @model for the link
631 * specified by @link.
633 * If the link exists, the linked #GMenuModel is returned. If the link
634 * does not exist, %NULL is returned.
636 * Returns: (transfer full): the linked #GMenuModel, or %NULL
641 g_menu_model_get_item_link (GMenuModel
*model
,
645 return G_MENU_MODEL_GET_CLASS (model
)
646 ->get_item_link (model
, item_index
, link
);
650 * g_menu_model_items_changed:
651 * @model: a #GMenuModel
652 * @position: the position of the change
653 * @removed: the number of items removed
654 * @added: the number of items added
656 * Requests emission of the #GMenuModel::items-changed signal on @model.
658 * This function should never be called except by #GMenuModel
659 * subclasses. Any other calls to this function will very likely lead
660 * to a violation of the interface of the model.
662 * The implementation should update its internal representation of the
663 * menu before emitting the signal. The implementation should further
664 * expect to receive queries about the new state of the menu (and
665 * particularly added menu items) while signal handlers are running.
667 * The implementation must dispatch this call directly from a mainloop
668 * entry and not in response to calls -- particularly those from the
669 * #GMenuModel API. Said another way: the menu must not change while
670 * user code is running without returning to the mainloop.
675 g_menu_model_items_changed (GMenuModel
*model
,
680 g_signal_emit (model
, g_menu_model_items_changed_signal
, 0, position
, removed
, added
);
683 G_DEFINE_ABSTRACT_TYPE (GMenuAttributeIter
, g_menu_attribute_iter
, G_TYPE_OBJECT
)
685 struct _GMenuAttributeIterPrivate
693 * g_menu_attribute_iter_get_next:
694 * @iter: a #GMenuAttributeIter
695 * @out_name: (out) (allow-none) (transfer none): the type of the attribute
696 * @value: (out) (allow-none) (transfer full): the attribute value
698 * This function combines g_menu_attribute_iter_next() with
699 * g_menu_attribute_iter_get_name() and g_menu_attribute_iter_get_value().
701 * First the iterator is advanced to the next (possibly first) attribute.
702 * If that fails, then %FALSE is returned and there are no other
705 * If successful, @name and @value are set to the name and value of the
706 * attribute that has just been advanced to. At this point,
707 * g_menu_item_get_name() and g_menu_item_get_value() will return the
710 * The value returned in @name remains valid for as long as the iterator
711 * remains at the current position. The value returned in @value must
712 * be unreffed using g_variant_unref() when it is no longer in use.
714 * Returns: %TRUE on success, or %FALSE if there is no additional
720 g_menu_attribute_iter_get_next (GMenuAttributeIter
*iter
,
721 const gchar
**out_name
,
726 if (iter
->priv
->value
)
728 g_variant_unref (iter
->priv
->value
);
729 iter
->priv
->value
= NULL
;
732 iter
->priv
->valid
= G_MENU_ATTRIBUTE_ITER_GET_CLASS (iter
)
733 ->get_next (iter
, &name
, &iter
->priv
->value
);
735 if (iter
->priv
->valid
)
737 iter
->priv
->name
= g_quark_from_string (name
);
739 *out_name
= g_quark_to_string (iter
->priv
->name
);
742 *value
= g_variant_ref (iter
->priv
->value
);
745 return iter
->priv
->valid
;
749 * g_menu_attribute_iter_next:
750 * @iter: a #GMenuAttributeIter
752 * Attempts to advance the iterator to the next (possibly first)
755 * %TRUE is returned on success, or %FALSE if there are no more
758 * You must call this function when you first acquire the iterator
759 * to advance it to the first attribute (and determine if the first
760 * attribute exists at all).
762 * Returns: %TRUE on success, or %FALSE when there are no more attributes
767 g_menu_attribute_iter_next (GMenuAttributeIter
*iter
)
769 return g_menu_attribute_iter_get_next (iter
, NULL
, NULL
);
773 * g_menu_attribute_iter_get_name:
774 * @iter: a #GMenuAttributeIter
776 * Gets the name of the attribute at the current iterator position, as
779 * The iterator is not advanced.
781 * Returns: the name of the attribute
786 g_menu_attribute_iter_get_name (GMenuAttributeIter
*iter
)
788 g_return_val_if_fail (iter
->priv
->valid
, 0);
790 return g_quark_to_string (iter
->priv
->name
);
794 * g_menu_attribute_iter_get_value:
795 * @iter: a #GMenuAttributeIter
797 * Gets the value of the attribute at the current iterator position.
799 * The iterator is not advanced.
801 * Returns: (transfer full): the value of the current attribute
806 g_menu_attribute_iter_get_value (GMenuAttributeIter
*iter
)
808 g_return_val_if_fail (iter
->priv
->valid
, NULL
);
810 return g_variant_ref (iter
->priv
->value
);
814 g_menu_attribute_iter_finalize (GObject
*object
)
816 GMenuAttributeIter
*iter
= G_MENU_ATTRIBUTE_ITER (object
);
818 if (iter
->priv
->value
)
819 g_variant_unref (iter
->priv
->value
);
821 G_OBJECT_CLASS (g_menu_attribute_iter_parent_class
)
826 g_menu_attribute_iter_init (GMenuAttributeIter
*iter
)
828 iter
->priv
= G_TYPE_INSTANCE_GET_PRIVATE (iter
, G_TYPE_MENU_ATTRIBUTE_ITER
, GMenuAttributeIterPrivate
);
832 g_menu_attribute_iter_class_init (GMenuAttributeIterClass
*class)
834 GObjectClass
*object_class
= G_OBJECT_CLASS (class);
836 object_class
->finalize
= g_menu_attribute_iter_finalize
;
838 g_type_class_add_private (class, sizeof (GMenuAttributeIterPrivate
));
841 G_DEFINE_ABSTRACT_TYPE (GMenuLinkIter
, g_menu_link_iter
, G_TYPE_OBJECT
)
843 struct _GMenuLinkIterPrivate
851 * g_menu_link_iter_get_next:
852 * @iter: a #GMenuLinkIter
853 * @out_link: (out) (allow-none) (transfer none): the name of the link
854 * @value: (out) (allow-none) (transfer full): the linked #GMenuModel
856 * This function combines g_menu_link_iter_next() with
857 * g_menu_link_iter_get_name() and g_menu_link_iter_get_value().
859 * First the iterator is advanced to the next (possibly first) link.
860 * If that fails, then %FALSE is returned and there are no other effects.
862 * If successful, @out_link and @value are set to the name and #GMenuModel
863 * of the link that has just been advanced to. At this point,
864 * g_menu_item_get_name() and g_menu_item_get_value() will return the
867 * The value returned in @out_link remains valid for as long as the iterator
868 * remains at the current position. The value returned in @value must
869 * be unreffed using g_object_unref() when it is no longer in use.
871 * Returns: %TRUE on success, or %FALSE if there is no additional link
876 g_menu_link_iter_get_next (GMenuLinkIter
*iter
,
877 const gchar
**out_link
,
882 if (iter
->priv
->value
)
884 g_object_unref (iter
->priv
->value
);
885 iter
->priv
->value
= NULL
;
888 iter
->priv
->valid
= G_MENU_LINK_ITER_GET_CLASS (iter
)
889 ->get_next (iter
, &name
, &iter
->priv
->value
);
891 if (iter
->priv
->valid
)
893 g_assert (name
!= NULL
);
895 iter
->priv
->name
= g_quark_from_string (name
);
897 *out_link
= g_quark_to_string (iter
->priv
->name
);
900 *value
= g_object_ref (iter
->priv
->value
);
903 return iter
->priv
->valid
;
907 * g_menu_link_iter_next:
908 * @iter: a #GMenuLinkIter
910 * Attempts to advance the iterator to the next (possibly first)
913 * %TRUE is returned on success, or %FALSE if there are no more links.
915 * You must call this function when you first acquire the iterator to
916 * advance it to the first link (and determine if the first link exists
919 * Returns: %TRUE on success, or %FALSE when there are no more links
924 g_menu_link_iter_next (GMenuLinkIter
*iter
)
926 return g_menu_link_iter_get_next (iter
, NULL
, NULL
);
930 * g_menu_link_iter_get_name:
931 * @iter: a #GMenuLinkIter
933 * Gets the name of the link at the current iterator position.
935 * The iterator is not advanced.
937 * Returns: the type of the link
942 g_menu_link_iter_get_name (GMenuLinkIter
*iter
)
944 g_return_val_if_fail (iter
->priv
->valid
, 0);
946 return g_quark_to_string (iter
->priv
->name
);
950 * g_menu_link_iter_get_value:
951 * @iter: a #GMenuLinkIter
953 * Gets the linked #GMenuModel at the current iterator position.
955 * The iterator is not advanced.
957 * Returns: (transfer full): the #GMenuModel that is linked to
962 g_menu_link_iter_get_value (GMenuLinkIter
*iter
)
964 g_return_val_if_fail (iter
->priv
->valid
, NULL
);
966 return g_object_ref (iter
->priv
->value
);
970 g_menu_link_iter_finalize (GObject
*object
)
972 GMenuLinkIter
*iter
= G_MENU_LINK_ITER (object
);
974 if (iter
->priv
->value
)
975 g_object_unref (iter
->priv
->value
);
977 G_OBJECT_CLASS (g_menu_link_iter_parent_class
)
982 g_menu_link_iter_init (GMenuLinkIter
*iter
)
984 iter
->priv
= G_TYPE_INSTANCE_GET_PRIVATE (iter
, G_TYPE_MENU_LINK_ITER
, GMenuLinkIterPrivate
);
988 g_menu_link_iter_class_init (GMenuLinkIterClass
*class)
990 GObjectClass
*object_class
= G_OBJECT_CLASS (class);
992 object_class
->finalize
= g_menu_link_iter_finalize
;
994 g_type_class_add_private (class, sizeof (GMenuLinkIterPrivate
));