gschem/include/gschemhotkeystore.h

   1 /* gEDA - GPL Electronic Design Automation
   2  * gschem - gEDA Schematic Capture
   3  * Copyright (C) 2013 Peter Brett <peter@peter-b.co.uk>
   4  * Copyright (C) 2013-2020 gEDA Contributors (see ChangeLog for details)
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef __GSCHEM_HOTKEY_STORE_H__
  22 #define __GSCHEM_HOTKEY_STORE_H__
  23
  24 G_BEGIN_DECLS
  25
  26 /* ---------------------------------------------------------------- */
  27
  28 /*! \class GschemHotkeyStore gschemhotkeystore.h "gschemhotkeystore.h"
  29  * \brief GtkTreeModel that contains keybinding data.
  30  *
  31  * A GtkListStore that contains a list of user editing actions with
  32  * their icons and their current keybindings.  The store automatically
  33  * updates when any of the actions' labels, icons or keybindings are
  34  * changed.
  35  */
  36
  37 #define GSCHEM_TYPE_HOTKEY_STORE (gschem_hotkey_store_get_type ())
  38 #define GSCHEM_HOTKEY_STORE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GSCHEM_TYPE_HOTKEY_STORE, GschemHotkeyStore))
  39 #define GSCHEM_HOTKEY_STORE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GSCHEM_TYPE_HOTKEY_STORE, GschemHotkeyStoreClass))
  40 #define GSCHEM_IS_HOTKEY_STORE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GSCHEM_TYPE_HOTKEY_STORE))
  41 #define GSCHEM_IS_HOTKEY_STORE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GSCHEM_TYPE_HOTKEY_STORE))
  42 #define GSCHEM_HOTKEY_STORE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GSCHEM_TYPE_HOTKEY_STORE, GschemHotkeyStoreClass))
  43
  44 enum {
  45   GSCHEM_HOTKEY_STORE_COLUMN_ICON  = 0,
  46   GSCHEM_HOTKEY_STORE_COLUMN_LABEL,
  47   GSCHEM_HOTKEY_STORE_COLUMN_KEYS,
  48   GSCHEM_HOTKEY_STORE_NUM_COLUMNS,
  49 };
  50
  51 typedef struct _GschemHotkeyStoreClass GschemHotkeyStoreClass;
  52 typedef struct _GschemHotkeyStore GschemHotkeyStore;
  53
  54 struct _GschemHotkeyStoreClass
  55 {
  56   GtkListStoreClass parent_class;
  57 };
  58
  59 struct _GschemHotkeyStore
  60 {
  61   GtkListStore parent_instance;
  62
  63   /* Protected members */
  64   EdascmHookProxy *action_hook_proxy;
  65   EdascmHookProxy *keymap_hook_proxy;
  66   guint rebuild_source_id;
  67 };
  68
  69 GType gschem_hotkey_store_get_type (void) G_GNUC_CONST;
  70
  71 GschemHotkeyStore *gschem_hotkey_store_new (void) G_GNUC_WARN_UNUSED_RESULT;
  72
  73 G_END_DECLS
  74
  75 #endif /* ! __GSCHEM_HOTKEY_STORE_H__ */