Sat, 18 May 2019 23:11:27 +0000
Merged in release-2.x.y (pull request #74)
Also deprecate gnt_file_sel_set_read_fn.
Approved-by: Gary Kramlich
/* * GNT - The GLib Ncurses Toolkit * * GNT is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This library is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA */ #ifndef GNT_MENU_H #define GNT_MENU_H /** * SECTION:gntmenu * @section_id: libgnt-gntmenu * @title: GntMenu * @short_description: A widget for a toplevel or popup menu * @see_also: #GntMenuItem #GntMenuItemCheck */ #include "gnt.h" #include "gnttree.h" #include "gntcolors.h" #include "gntkeys.h" #define GNT_TYPE_MENU (gnt_menu_get_gtype()) #define GNT_MENU(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_MENU, GntMenu)) #define GNT_MENU_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_MENU, GntMenuClass)) #define GNT_IS_MENU(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_MENU)) #define GNT_IS_MENU_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_MENU)) #define GNT_MENU_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_MENU, GntMenuClass)) #ifndef GNT_DISABLE_DEPRECATED /** * GNT_MENU_FLAGS: * * Deprecated: 2.14.0: This is an internal implementation detail. */ #define GNT_MENU_FLAGS(obj) (GNT_MENU(obj)->priv.flags) /** * GNT_MENU_SET_FLAGS: * * Deprecated: 2.14.0: This is an internal implementation detail. */ #define GNT_MENU_SET_FLAGS(obj, flags) (GNT_MENU_FLAGS(obj) |= flags) /** * GNT_MENU_UNSET_FLAGS: * * Deprecated: 2.14.0: This is an internal implementation detail. */ #define GNT_MENU_UNSET_FLAGS(obj, flags) (GNT_MENU_FLAGS(obj) &= ~(flags)) #endif typedef struct _GntMenu GntMenu; typedef struct _GntMenuClass GntMenuClass; #ifndef GNT_DISABLE_DEPRECATED /** * GntMenuPriv: * * Deprecated: 2.14.0: This is an internal implementation detail. */ typedef struct _GntMenuPriv GntMenuPriv; #endif #include "gntmenuitem.h" /** * GntMenuType: * @GNT_MENU_TOPLEVEL: Menu for a toplevel window * @GNT_MENU_POPUP: A popup menu * * A toplevel-menu is displayed at the top of the screen, and it spans accross * the entire width of the screen. * A popup-menu could be displayed, for example, as a context menu for widgets. */ typedef enum { GNT_MENU_TOPLEVEL = 1, GNT_MENU_POPUP, } GntMenuType; /** * GntMenu: * * Access to any fields is deprecated. See inline comments for replacements. */ struct _GntMenu { GntTree parent; GntMenuType GNTSEAL(type); GList *GNTSEAL(list); int GNTSEAL(selected); /* This will keep track of its immediate submenu which is visible so that * keystrokes can be passed to it. */ GntMenu *GNTSEAL(submenu); GntMenu *GNTSEAL(parentmenu); }; struct _GntMenuClass { GntTreeClass parent; /*< private >*/ void (*gnt_reserved1)(void); void (*gnt_reserved2)(void); void (*gnt_reserved3)(void); void (*gnt_reserved4)(void); }; G_BEGIN_DECLS /** * gnt_menu_get_gtype: * * Returns: The GType for GntMenu. */ GType gnt_menu_get_gtype(void); /** * gnt_menu_new: * @type: The type of the menu, whether it's a toplevel menu or a popup menu. * * Create a new menu. * * Returns: The newly created menu. */ GntWidget * gnt_menu_new(GntMenuType type); /** * gnt_menu_add_item: * @menu: The menu. * @item: The item to add to the menu. * * Add an item to the menu. */ void gnt_menu_add_item(GntMenu *menu, GntMenuItem *item); /** * gnt_menu_get_item: * @menu: The menu. * @id: The ID for an item. * * Return the GntMenuItem with the given ID. * * Returns: (transfer none): The menuitem with the given ID, or %NULL. * * Since: 2.3.0 */ GntMenuItem *gnt_menu_get_item(GntMenu *menu, const char *id); G_END_DECLS #endif /* GNT_MENU_H */