src/ui-menu.h

   1 /*
   2  * Copyright (C) 2004 John Ellis
   3  * Copyright (C) 2008 - 2016 The Geeqie Team
   4  *
   5  * Author: John Ellis
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifndef UI_MENU_H
  23 #define UI_MENU_H
  24
  25
  26 /**
  27  * @struct hard_coded_window_keys
  28  * @brief hard coded window shortcut keys
  29  *
  30  * Used for two purposes:\n
  31  * to display the shortcuts keys in popup menus\n
  32  * used by ./doc/create-shortcuts-xml.sh to generate shortcut documentation in the Help files
  33  *
  34  */
  35 struct hard_coded_window_keys {
  36         GdkModifierType mask; /**< modifier key mask */
  37         guint key_value;  /**< GDK_keyval */
  38         const gchar *text;  /**< menu item label - NULL if end of list */
  39 };
  40
  41 GtkWidget *menu_item_add(GtkWidget *menu, const gchar *label,
  42                          GCallback func, gpointer data);
  43 GtkWidget *menu_item_add_stock(GtkWidget *menu, const gchar *label, const gchar *stock_id,
  44                                GCallback func, gpointer data);
  45 GtkWidget *menu_item_add_icon(GtkWidget *menu, const gchar *label, const gchar *icon_name,
  46                                GCallback func, gpointer data);
  47 GtkWidget *menu_item_add_sensitive(GtkWidget *menu, const gchar *label, gboolean sensitive,
  48                                    GCallback func, gpointer data);
  49 GtkWidget *menu_item_add_icon_sensitive(GtkWidget *menu, const gchar *label, const gchar *icon_name, gboolean sensitive,
  50                                          GCallback func, gpointer data);
  51 GtkWidget *menu_item_add_stock_sensitive(GtkWidget *menu, const gchar *label, const gchar *stock_id, gboolean sensitive,
  52                                          GCallback func, gpointer data);
  53 GtkWidget *menu_item_add_check(GtkWidget *menu, const gchar *label, gboolean active,
  54                                GCallback func, gpointer data);
  55 GtkWidget *menu_item_add_radio(GtkWidget *menu, const gchar *label, gpointer item_data, gboolean active,
  56                                GCallback func, gpointer data);
  57 void menu_item_add_divider(GtkWidget *menu);
  58
  59 /**
  60  * @headerfile menu_item_add_simple
  61  * use to avoid mnemonics, for example filenames
  62  */
  63 GtkWidget *menu_item_add_simple(GtkWidget *menu, const gchar *label,
  64                                 GCallback func, gpointer data);
  65
  66 GtkWidget *popup_menu_short_lived();
  67
  68 /**
  69  * @headerfile popup_menu_position_clamp
  70  * clamp a menu's position to within the screen
  71  * if menu will attempt to stay out of region y to y+height
  72  */
  73 gboolean popup_menu_position_clamp(GtkMenu *menu, gint *x, gint *y, gint height);
  74
  75
  76 #endif
  77 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */