gimpdialogfactory.h 11.2 KB
Newer Older
1
/* GIMP - The GNU Image Manipulation Program
2 3 4
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * gimpdialogfactory.h
5
 * Copyright (C) 2001 Michael Natterer <mitch@gimp.org>
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 3 of the License, or
10 11 12 13 14 15 16 17
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
18
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 20 21 22 23 24
 */

#ifndef __GIMP_DIALOG_FACTORY_H__
#define __GIMP_DIALOG_FACTORY_H__


25
#include "core/gimpobject.h"
26

27 28 29 30 31 32
#define GIMP_DIALOG_VISIBILITY_KEY "gimp-dialog-visibility"

typedef enum
{
  GIMP_DIALOG_VISIBILITY_UNKNOWN = 0,
  GIMP_DIALOG_VISIBILITY_INVISIBLE,
33 34
  GIMP_DIALOG_VISIBILITY_VISIBLE,
  GIMP_DIALOG_VISIBILITY_HIDDEN
35 36 37
} GimpDialogVisibilityState;


38 39 40 41
/* In order to support constructors of various types, these functions
 * takes the union of the set of arguments required for each type of
 * widget constructor. If this set becomes too big we can consider
 * passing a struct or use varargs.
42
 */
43 44
typedef GtkWidget * (* GimpDialogNewFunc)     (GimpDialogFactory      *factory,
                                               GimpContext            *context,
45
                                               GimpUIManager          *ui_manager,
46
                                               gint                    view_size);
47 48 49 50


struct _GimpDialogFactoryEntry
{
51 52 53
  gchar                *identifier;
  gchar                *name;
  gchar                *blurb;
54
  gchar                *icon_name;
55
  gchar                *help_id;
56

57 58 59
  GimpDialogNewFunc     new_func;
  GimpDialogRestoreFunc restore_func;
  gint                  view_size;
60

61 62 63 64
  gboolean              singleton;
  gboolean              session_managed;
  gboolean              remember_size;
  gboolean              remember_if_open;
65

66
  /* If TRUE the visibility of the dialog is toggleable */
67
  gboolean              hideable;
68

69
  /* If TRUE the entry is for a GimpImageWindow, FALSE otherwise */
70
  gboolean              image_window;
71

72
  /* If TRUE the entry is for a dockable, FALSE otherwise */
73
  gboolean              dockable;
74 75
};

76 77

#define GIMP_TYPE_DIALOG_FACTORY            (gimp_dialog_factory_get_type ())
78 79 80 81 82
#define GIMP_DIALOG_FACTORY(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_DIALOG_FACTORY, GimpDialogFactory))
#define GIMP_DIALOG_FACTORY_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_DIALOG_FACTORY, GimpDialogFactoryClass))
#define GIMP_IS_DIALOG_FACTORY(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_DIALOG_FACTORY))
#define GIMP_IS_DIALOG_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_DIALOG_FACTORY))
#define GIMP_DIALOG_FACTORY_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_DIALOG_FACTORY, GimpDialogFactoryClass))
83 84


85 86
typedef struct _GimpDialogFactoryPrivate  GimpDialogFactoryPrivate;
typedef struct _GimpDialogFactoryClass    GimpDialogFactoryClass;
87

88 89 90 91 92 93 94
/**
 * GimpDialogFactory:
 *
 * A factory with the main purpose of creating toplevel windows and
 * position them according to the session information kept within the
 * factory. Over time it has accumulated more functionality than this.
 */
95 96
struct _GimpDialogFactory
{
97
  GimpObject                parent_instance;
98

99
  GimpDialogFactoryPrivate *p;
100 101 102 103 104
};

struct _GimpDialogFactoryClass
{
  GimpObjectClass  parent_class;
105

106 107 108 109
  void (* dock_window_added)   (GimpDialogFactory *factory,
                                GimpDockWindow    *dock_window);
  void (* dock_window_removed) (GimpDialogFactory *factory,
                                GimpDockWindow    *dock_window);
110 111 112
};


113 114 115
GType               gimp_dialog_factory_get_type             (void) G_GNUC_CONST;
GimpDialogFactory * gimp_dialog_factory_new                  (const gchar             *name,
                                                              GimpContext             *context,
116
                                                              GimpMenuFactory         *menu_factory);
117 118 119 120
void                gimp_dialog_factory_register_entry       (GimpDialogFactory       *factory,
                                                              const gchar             *identifier,
                                                              const gchar             *name,
                                                              const gchar             *blurb,
121
                                                              const gchar             *icon_name,
122 123
                                                              const gchar             *help_id,
                                                              GimpDialogNewFunc        new_func,
124
                                                              GimpDialogRestoreFunc    restore_func,
125 126 127 128
                                                              gint                     view_size,
                                                              gboolean                 singleton,
                                                              gboolean                 session_managed,
                                                              gboolean                 remember_size,
129
                                                              gboolean                 remember_if_open,
130
                                                              gboolean                 hideable,
131
                                                              gboolean                 image_window,
132
                                                              gboolean                 dockable);
133 134 135 136 137
GimpDialogFactoryEntry *
                    gimp_dialog_factory_find_entry           (GimpDialogFactory       *factory,
                                                              const gchar             *identifier);
GimpSessionInfo *   gimp_dialog_factory_find_session_info    (GimpDialogFactory       *factory,
                                                              const gchar             *identifier);
138
GtkWidget *         gimp_dialog_factory_find_widget          (GimpDialogFactory       *factory,
139
                                                              const gchar             *identifiers);
140
GtkWidget *         gimp_dialog_factory_dialog_new           (GimpDialogFactory       *factory,
141
                                                              GdkMonitor              *monitor,
142
                                                              GimpUIManager           *ui_manager,
143
                                                              GtkWidget               *parent,
144 145 146
                                                              const gchar             *identifier,
                                                              gint                     view_size,
                                                              gboolean                 present);
147 148 149 150 151 152
GimpContext *       gimp_dialog_factory_get_context          (GimpDialogFactory       *factory);
GimpMenuFactory *   gimp_dialog_factory_get_menu_factory     (GimpDialogFactory       *factory);
GList *             gimp_dialog_factory_get_open_dialogs     (GimpDialogFactory       *factory);
GList *             gimp_dialog_factory_get_session_infos    (GimpDialogFactory       *factory);
void                gimp_dialog_factory_add_session_info     (GimpDialogFactory       *factory,
                                                              GimpSessionInfo         *info);
153
GtkWidget *         gimp_dialog_factory_dialog_raise         (GimpDialogFactory       *factory,
154
                                                              GdkMonitor              *monitor,
155
                                                              GtkWidget               *parent,
156 157 158 159 160 161 162
                                                              const gchar             *identifiers,
                                                              gint                     view_size);
GtkWidget *         gimp_dialog_factory_dockable_new         (GimpDialogFactory       *factory,
                                                              GimpDock                *dock,
                                                              const gchar             *identifier,
                                                              gint                     view_size);
void                gimp_dialog_factory_add_dialog           (GimpDialogFactory       *factory,
163
                                                              GtkWidget               *dialog,
164
                                                              GdkMonitor              *monitor);
165 166
void                gimp_dialog_factory_add_foreign          (GimpDialogFactory       *factory,
                                                              const gchar             *identifier,
167
                                                              GtkWidget               *dialog,
168
                                                              GdkMonitor              *monitor);
169 170 171
void                gimp_dialog_factory_remove_dialog        (GimpDialogFactory       *factory,
                                                              GtkWidget               *dialog);
void                gimp_dialog_factory_hide_dialog          (GtkWidget               *dialog);
172 173
void                gimp_dialog_factory_save                 (GimpDialogFactory       *factory,
                                                              GimpConfigWriter        *writer);
174
void                gimp_dialog_factory_restore              (GimpDialogFactory       *factory,
175
                                                              GdkMonitor              *monitor);
176 177 178 179 180
void                gimp_dialog_factory_set_state            (GimpDialogFactory       *factory,
                                                              GimpDialogsState         state);
GimpDialogsState    gimp_dialog_factory_get_state            (GimpDialogFactory       *factory);
void                gimp_dialog_factory_show_with_display    (GimpDialogFactory       *factory);
void                gimp_dialog_factory_hide_with_display    (GimpDialogFactory       *factory);
181 182
void                gimp_dialog_factory_set_busy             (GimpDialogFactory       *factory);
void                gimp_dialog_factory_unset_busy           (GimpDialogFactory       *factory);
183 184 185 186 187
GimpDialogFactory * gimp_dialog_factory_from_widget          (GtkWidget               *dialog,
                                                              GimpDialogFactoryEntry **entry);
void                gimp_dialog_factory_set_has_min_size     (GtkWindow               *window,
                                                              gboolean                 has_min_size);
gboolean            gimp_dialog_factory_get_has_min_size     (GtkWindow               *window);
188

189 190 191
GimpDialogFactory * gimp_dialog_factory_get_singleton        (void);
void                gimp_dialog_factory_set_singleton        (GimpDialogFactory       *factory);

192 193

#endif  /*  __GIMP_DIALOG_FACTORY_H__  */