gschem/include/gschem_dockable.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_DOCKABLE_H
  22 #define GSCHEM_DOCKABLE_H
  23
  24 #define GSCHEM_TYPE_DOCKABLE_STATE     (gschem_dockable_state_get_type ())
  25
  26 #define GSCHEM_TYPE_DOCKABLE           (gschem_dockable_get_type ())
  27 #define GSCHEM_DOCKABLE(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), GSCHEM_TYPE_DOCKABLE, GschemDockable))
  28 #define GSCHEM_DOCKABLE_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GSCHEM_TYPE_DOCKABLE, GschemDockableClass))
  29 #define GSCHEM_IS_DOCKABLE(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GSCHEM_TYPE_DOCKABLE))
  30 #define GSCHEM_DOCKABLE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GSCHEM_TYPE_DOCKABLE, GschemDockableClass))
  31
  32 typedef enum {
  33   GSCHEM_DOCKABLE_STATE_HIDDEN,
  34   GSCHEM_DOCKABLE_STATE_DIALOG,
  35   GSCHEM_DOCKABLE_STATE_WINDOW,
  36   GSCHEM_DOCKABLE_STATE_DOCKED_LEFT,
  37   GSCHEM_DOCKABLE_STATE_DOCKED_BOTTOM,
  38   GSCHEM_DOCKABLE_STATE_DOCKED_RIGHT
  39 } GschemDockableState;
  40
  41 typedef struct _GschemDockableClass GschemDockableClass;
  42 typedef struct _GschemDockable      GschemDockable;
  43
  44 struct _GschemDockableClass {
  45   GObjectClass parent_class;
  46
  47   GtkWidget *(*create_widget) (GschemDockable *dockable);
  48   void (*post_present) (GschemDockable *dockable);
  49   void (*cancel) (GschemDockable *dockable);
  50
  51   void (*save_internal_geometry)    (GschemDockable *dockable,
  52                                      EdaConfig *cfg,
  53                                      gchar *group_name);
  54   void (*restore_internal_geometry) (GschemDockable *dockable,
  55                                      EdaConfig *cfg,
  56                                      gchar *group_name);
  57 };
  58
  59 struct _GschemDockable {
  60   GObject parent_instance;
  61
  62   GschemToplevel *w_current;
  63
  64   gchar *title;
  65   gchar *settings_name, *group_name;
  66   gboolean cancellable;
  67   gchar *help_page;
  68
  69   GschemDockableState initial_state;
  70   gint initial_width, initial_height;
  71   GtkWindowPosition initial_position;
  72
  73   GtkWidget *widget, *window, *vbox, *action_area;
  74   GtkWidget *hide_button, *cancel_button, *help_button;
  75
  76   GtkWidget *dock_left_item, *dock_bottom_item, *dock_right_item;
  77   GtkWidget *menu, *detach_item, *move_left_item, *move_bottom_item,
  78                    *move_right_item, *close_item;
  79 };
  80
  81 GType gschem_dockable_state_get_type (void);
  82 GType gschem_dockable_get_type (void);
  83
  84 void gschem_dockable_hide (GschemDockable *dockable);
  85 void gschem_dockable_detach (GschemDockable *dockable,
  86                              gboolean show_action_area);
  87 void gschem_dockable_attach_to_notebook (GschemDockable *dockable,
  88                                          GtkWidget *notebook);
  89
  90 GschemDockableState gschem_dockable_get_state (GschemDockable *dockable);
  91 void gschem_dockable_set_state (GschemDockable *dockable,
  92                                 GschemDockableState state);
  93
  94 void gschem_dockable_present (GschemDockable *dockable);
  95
  96
  97 void gschem_dockable_initialize_toplevel (GschemToplevel *w_current);
  98 void gschem_dockable_cleanup_toplevel (GschemToplevel *w_current);
  99
 100 #endif /* GSCHEM_DOCKABLE_H */