gntwindow.h

   1 /**
   2  * @file gntwindow.h Window API
   3  * @ingroup gnt
   4  */
   5 /*
   6  * GNT - The GLib Ncurses Toolkit
   7  *
   8  * GNT is the legal property of its developers, whose names are too numerous
   9  * to list here.  Please refer to the COPYRIGHT file distributed with this
  10  * source distribution.
  11  *
  12  * This library is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  25  */
  26
  27 #ifndef GNT_WINDOW_H
  28 #define GNT_WINDOW_H
  29
  30 #include "gnt.h"
  31 #include "gntbox.h"
  32 #include "gntcolors.h"
  33 #include "gntkeys.h"
  34 #include "gntmenu.h"
  35
  36 #define GNT_TYPE_WINDOW                         (gnt_window_get_gtype())
  37 #define GNT_WINDOW(obj)                         (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_WINDOW, GntWindow))
  38 #define GNT_WINDOW_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_WINDOW, GntWindowClass))
  39 #define GNT_IS_WINDOW(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_WINDOW))
  40 #define GNT_IS_WINDOW_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_WINDOW))
  41 #define GNT_WINDOW_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_WINDOW, GntWindowClass))
  42
  43 #define GNT_WINDOW_FLAGS(obj)                           (GNT_WINDOW(obj)->priv.flags)
  44 #define GNT_WINDOW_SET_FLAGS(obj, flags)                (GNT_WINDOW_FLAGS(obj) |= flags)
  45 #define GNT_WINDOW_UNSET_FLAGS(obj, flags)      (GNT_WINDOW_FLAGS(obj) &= ~(flags))
  46
  47 typedef struct _GntWindow                       GntWindow;
  48 typedef struct _GntWindowPriv           GntWindowPriv;
  49 typedef struct _GntWindowClass          GntWindowClass;
  50
  51 struct _GntWindow
  52 {
  53         GntBox parent;
  54         GntMenu *menu;
  55         GntWindowPriv *priv;
  56 };
  57
  58 struct _GntWindowClass
  59 {
  60         GntBoxClass parent;
  61
  62         void (*gnt_reserved1)(void);
  63         void (*gnt_reserved2)(void);
  64         void (*gnt_reserved3)(void);
  65         void (*gnt_reserved4)(void);
  66 };
  67
  68 G_BEGIN_DECLS
  69
  70 /**
  71  * @return  GType for GntWindow.
  72  */
  73 GType gnt_window_get_gtype(void);
  74
  75 #define gnt_vwindow_new(homo) gnt_window_box_new(homo, TRUE)
  76 #define gnt_hwindow_new(homo) gnt_window_box_new(homo, FALSE)
  77
  78 /**
  79  * Create a new window.
  80  *
  81  * @return The newly created window.
  82  */
  83 GntWidget * gnt_window_new(void);
  84
  85 /**
  86  * Create a new window.
  87  *
  88  * @param homo  @c TRUE if the widgets inside the window should have the same dimensions.
  89  * @param vert  @c TRUE if the widgets inside the window should be stacked vertically.
  90  *
  91  * @return  The newly created window.
  92  */
  93 GntWidget * gnt_window_box_new(gboolean homo, gboolean vert);
  94
  95 /**
  96  * Set the menu for a window.
  97  *
  98  * @param window  The window.
  99  * @param menu    The menu for the window.
 100  */
 101 void gnt_window_set_menu(GntWindow *window, GntMenu *menu);
 102
 103 /**
 104  * Return the id of a menuitem specified to a keystroke.
 105  *
 106  * @param window    The window.
 107  * @param key       The keystroke.
 108  *
 109  * @return The id of the menuitem bound to the keystroke, or @c NULL.
 110  *
 111  * @since 2.3.0
 112  */
 113 const char * gnt_window_get_accel_item(GntWindow *window, const char *key);
 114
 115 void gnt_window_workspace_hiding(GntWindow *);
 116 void gnt_window_workspace_showing(GntWindow *);
 117
 118 G_END_DECLS
 119
 120 #endif /* GNT_WINDOW_H */