gschem/include/gschem_action.h

   1 /* gEDA - GPL Electronic Design Automation
   2  * gschem - gEDA Schematic Capture
   3  * Copyright (C) 1998-2010 Ales Hvezda
   4  * Copyright (C) 1998-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_ACTION_H
  22 #define GSCHEM_ACTION_H
  23
  24 #define GSCHEM_ACTION(obj) ((GschemAction *) (obj))
  25
  26 typedef enum {
  27   GSCHEM_ACTION_TYPE_ACTUATE,
  28   GSCHEM_ACTION_TYPE_TOGGLE_PLAIN,
  29   GSCHEM_ACTION_TYPE_TOGGLE_CHECK,
  30   GSCHEM_ACTION_TYPE_TOGGLE_RADIO
  31 } GschemActionType;
  32
  33 typedef struct _GschemAction GschemAction;
  34
  35 struct _GschemAction {
  36   gchar *id;
  37   gchar *icon_name;
  38   gchar *name;
  39   gchar *label;
  40   gchar *menu_label;
  41   gchar *tooltip;
  42   GschemActionType type;
  43
  44   void (*activate) (GschemAction *action,
  45                     GschemToplevel *w_current);
  46
  47   SCM thunk;
  48   SCM smob;  /* not owned */
  49 };
  50
  51
  52 int scm_is_action (SCM x);
  53 GschemAction *scm_to_action (SCM smob);
  54
  55 void gschem_action_activate (GschemAction *action,
  56                              GschemToplevel *w_current);
  57
  58 GtkWidget *gschem_action_create_menu_item (GschemAction *action,
  59                                            gboolean use_menu_label,
  60                                            GschemToplevel *w_current);
  61 GtkToolItem *gschem_action_create_tool_button (GschemAction *action,
  62                                                GschemToplevel *w_current);
  63
  64 void gschem_action_set_sensitive (GschemAction *action, gboolean sensitive,
  65                                   GschemToplevel *w_current);
  66 void gschem_action_set_active (GschemAction *action, gboolean is_active,
  67                                GschemToplevel *w_current);
  68 void gschem_action_set_strings (GschemAction *action,
  69                                 gchar *name, gchar *label, gchar *menu_label,
  70                                 GschemToplevel *w_current);
  71
  72 GschemAction *gschem_action_register (gchar *id,
  73                                       gchar *icon_name,
  74                                       gchar *name,
  75                                       gchar *label,
  76                                       gchar *menu_label,
  77                                       gchar *tooltip,
  78                                       GschemActionType type,
  79                                       void (*activate) (GschemAction *,
  80                                                         GschemToplevel *));
  81
  82 void gschem_action_init (void);
  83
  84 #endif /* GSCHEM_ACTION_H */