1 /**
2 * \brief Base class for dialogs in Inkscape. This class provides certain
3 * common behaviors and styles wanted of all dialogs in the application.
4 *
5 * Author:
6 * Bryce W. Harrington <bryce@bryceharrington.org>
7 * buliabyak@gmail.com
8 * Johan Engelen <j.b.c.engelen@ewi.utwente.nl>
9 *
10 * Copyright (C) 2004-2007 Authors
11 *
12 * Released under GNU GPL. Read the file 'COPYING' for more information.
13 */
15 #ifdef HAVE_CONFIG_H
16 # include <config.h>
17 #endif
19 #include <gtkmm/stock.h>
20 #include <gtk/gtk.h>
22 #include "application/application.h"
23 #include "application/editor.h"
24 #include "inkscape.h"
25 #include "event-context.h"
26 #include "desktop.h"
27 #include "desktop-handles.h"
28 #include "dialog-manager.h"
29 #include "dialogs/dialog-events.h"
30 #include "shortcuts.h"
31 #include "prefs-utils.h"
32 #include "interface.h"
33 #include "verbs.h"
36 #define MIN_ONSCREEN_DISTANCE 50
40 namespace Inkscape {
41 namespace UI {
42 namespace Dialog {
44 static gboolean
45 sp_retransientize_again (gpointer dlgPtr)
46 {
47 Dialog *dlg = (Dialog *)dlgPtr;
48 dlg->retransientize_suppress = false;
49 return FALSE; // so that it is only called once
50 }
52 static void
53 sp_retransientize (Inkscape::Application *inkscape, SPDesktop *desktop, gpointer dlgPtr)
54 {
55 Dialog *dlg = (Dialog *)dlgPtr;
56 dlg->onDesktopActivated (desktop);
57 }
59 static void
60 sp_dialog_shutdown (GtkObject *object, gpointer dlgPtr)
61 {
62 Dialog *dlg = (Dialog *)dlgPtr;
63 dlg->onShutdown();
64 }
66 void
67 Dialog::present()
68 {
69 _user_hidden = false;
70 Gtk::Dialog::present();
71 }
73 void
74 Dialog::save_geometry()
75 {
76 int y, x, w, h;
78 get_position(x, y);
79 get_size(w, h);
81 // g_print ("write %d %d %d %d\n", x, y, w, h);
83 if (x<0) x=0;
84 if (y<0) y=0;
86 prefs_set_int_attribute (_prefs_path, "x", x);
87 prefs_set_int_attribute (_prefs_path, "y", y);
88 prefs_set_int_attribute (_prefs_path, "w", w);
89 prefs_set_int_attribute (_prefs_path, "h", h);
90 }
92 void
93 Dialog::read_geometry()
94 {
95 _user_hidden = false;
97 int x = prefs_get_int_attribute (_prefs_path, "x", -1000);
98 int y = prefs_get_int_attribute (_prefs_path, "y", -1000);
99 int w = prefs_get_int_attribute (_prefs_path, "w", 0);
100 int h = prefs_get_int_attribute (_prefs_path, "h", 0);
102 // g_print ("read %d %d %d %d\n", x, y, w, h);
104 // If there are stored height and width values for the dialog,
105 // resize the window to match; otherwise we leave it at its default
106 if (w != 0 && h != 0) {
107 resize (w, h);
108 }
110 // If there are stored values for where the dialog should be
111 // located, then restore the dialog to that position.
112 // also check if (x,y) is actually onscreen with the current screen dimensions
113 if ( (x >= 0) && (y >= 0) && (x < (gdk_screen_width()-MIN_ONSCREEN_DISTANCE)) && (y < (gdk_screen_height()-MIN_ONSCREEN_DISTANCE)) ) {
114 move(x, y);
115 } else {
116 // ...otherwise just put it in the middle of the screen
117 set_position(Gtk::WIN_POS_CENTER);
118 }
119 }
121 void hideCallback(GtkObject *object, gpointer dlgPtr)
122 {
123 g_return_if_fail( dlgPtr != NULL );
125 Dialog *dlg = (Dialog *)dlgPtr;
126 dlg->onHideF12();
127 }
129 void unhideCallback(GtkObject *object, gpointer dlgPtr)
130 {
131 g_return_if_fail( dlgPtr != NULL );
133 Dialog *dlg = (Dialog *)dlgPtr;
134 dlg->onShowF12();
135 }
137 //=====================================================================
139 /**
140 * UI::Dialog::Dialog is a base class for all dialogs in Inkscape. The
141 * purpose of this class is to provide a unified place for ensuring
142 * style and behavior. Specifically, this class provides functionality
143 * for saving and restoring the size and position of dialogs (through
144 * the user's preferences file).
145 *
146 * It also provides some general purpose signal handlers for things like
147 * showing and hiding all dialogs.
148 */
149 Dialog::Dialog(const char *prefs_path, int verb_num, const char *apply_label)
150 {
151 hide();
152 set_has_separator(false);
154 _prefs_path = prefs_path;
156 if (prefs_get_int_attribute ("dialogs", "showclose", 0) || apply_label) {
157 // TODO: make the order of buttons obey the global preference
158 if (apply_label) {
159 add_button(Glib::ustring(apply_label), Gtk::RESPONSE_APPLY);
160 set_default_response(Gtk::RESPONSE_APPLY);
161 }
162 add_button(Gtk::Stock::CLOSE, Gtk::RESPONSE_CLOSE);
163 }
165 GtkWidget *dlg = GTK_WIDGET(gobj());
167 if (verb_num)
168 {
169 gchar title[500];
170 sp_ui_dialog_title_string (Inkscape::Verb::get(verb_num), title);
171 set_title(title);
172 }
174 gtk_signal_connect( GTK_OBJECT (dlg), "event", GTK_SIGNAL_FUNC(sp_dialog_event_handler), dlg );
176 _hiddenF12 = false;
177 if (Inkscape::NSApplication::Application::getNewGui())
178 {
179 _desktop_activated_connection = Inkscape::NSApplication::Editor::connectDesktopActivated (sigc::mem_fun (*this, &Dialog::onDesktopActivated));
180 _dialogs_hidden_connection = Inkscape::NSApplication::Editor::connectDialogsHidden (sigc::mem_fun (*this, &Dialog::onHideF12));
181 _dialogs_unhidden_connection = Inkscape::NSApplication::Editor::connectDialogsUnhidden (sigc::mem_fun (*this, &Dialog::onShowF12));
182 _shutdown_connection = Inkscape::NSApplication::Editor::connectShutdown (sigc::mem_fun (*this, &Dialog::onShutdown));
183 }
184 else
185 {
186 g_signal_connect (G_OBJECT (INKSCAPE), "activate_desktop", G_CALLBACK (sp_retransientize), (void *)this);
187 g_signal_connect( G_OBJECT(INKSCAPE), "dialogs_hide", G_CALLBACK(hideCallback), (void *)this );
188 g_signal_connect( G_OBJECT(INKSCAPE), "dialogs_unhide", G_CALLBACK(unhideCallback), (void *)this );
189 g_signal_connect (G_OBJECT (INKSCAPE), "shut_down", G_CALLBACK (sp_dialog_shutdown), (void *)this);
190 }
192 g_signal_connect_after( gobj(), "key_press_event", (GCallback)windowKeyPress, NULL );
194 read_geometry();
195 present();
196 sp_transientize(dlg);
197 retransientize_suppress = false;
198 }
200 Dialog::Dialog(BaseObjectType *gobj)
201 : Gtk::Dialog(gobj)
202 {
203 }
205 Dialog::~Dialog()
206 {
207 if (Inkscape::NSApplication::Application::getNewGui())
208 {
209 _desktop_activated_connection.disconnect();
210 _dialogs_hidden_connection.disconnect();
211 _dialogs_unhidden_connection.disconnect();
212 _shutdown_connection.disconnect();
213 }
215 save_geometry();
216 }
219 bool Dialog::windowKeyPress( GtkWidget *widget, GdkEventKey *event )
220 {
221 unsigned int shortcut = 0;
222 shortcut = get_group0_keyval (event) |
223 ( event->state & GDK_SHIFT_MASK ?
224 SP_SHORTCUT_SHIFT_MASK : 0 ) |
225 ( event->state & GDK_CONTROL_MASK ?
226 SP_SHORTCUT_CONTROL_MASK : 0 ) |
227 ( event->state & GDK_MOD1_MASK ?
228 SP_SHORTCUT_ALT_MASK : 0 );
229 return sp_shortcut_invoke( shortcut, SP_ACTIVE_DESKTOP );
230 }
232 //---------------------------------------------------------------------
234 void
235 Dialog::on_response(int response_id)
236 {
237 switch (response_id) {
238 case Gtk::RESPONSE_APPLY: {
239 _apply();
240 break;
241 }
242 case Gtk::RESPONSE_CLOSE: {
243 _close();
244 break;
245 }
246 }
247 }
249 bool
250 Dialog::on_delete_event (GdkEventAny *event)
251 {
252 save_geometry();
253 _user_hidden = true;
255 return false;
256 }
258 void
259 Dialog::onHideF12()
260 {
261 _hiddenF12 = true;
262 save_geometry();
263 hide();
264 }
266 void
267 Dialog::onShowF12()
268 {
269 if (_user_hidden)
270 return;
272 if (_hiddenF12) {
273 show();
274 read_geometry();
275 }
277 _hiddenF12 = false;
278 }
280 void
281 Dialog::onShutdown()
282 {
283 save_geometry();
284 _user_hidden = true;
285 }
287 void
288 Dialog::onDesktopActivated (SPDesktop *desktop)
289 {
290 gint transient_policy = prefs_get_int_attribute_limited ( "options.transientpolicy", "value", 1, 0, 2);
292 #ifdef WIN32 // FIXME: Temporary Win32 special code to enable transient dialogs
293 if (prefs_get_int_attribute ( "options.dialogsontopwin32", "value", 0))
294 transient_policy = 2;
295 else
296 return;
297 #endif
299 if (!transient_policy)
300 return;
304 GtkWindow *dialog_win = GTK_WINDOW(gobj());
306 if (retransientize_suppress) {
307 /* if retransientizing of this dialog is still forbidden after
308 * previous call warning turned off because it was confusingly fired
309 * when loading many files from command line
310 */
312 // g_warning("Retranzientize aborted! You're switching windows too fast!");
313 return;
314 }
316 if (dialog_win)
317 {
318 retransientize_suppress = true; // disallow other attempts to retranzientize this dialog
320 desktop->setWindowTransient (dialog_win);
322 /*
323 * This enables "aggressive" transientization,
324 * i.e. dialogs always emerging on top when you switch documents. Note
325 * however that this breaks "click to raise" policy of a window
326 * manager because the switched-to document will be raised at once
327 * (so that its transients also could raise)
328 */
329 if (transient_policy == 2 && !_hiddenF12 && !_user_hidden) {
330 // without this, a transient window not always emerges on top
331 gtk_window_present (dialog_win);
332 }
333 }
335 // we're done, allow next retransientizing not sooner than after 120 msec
336 gtk_timeout_add (120, (GtkFunction) sp_retransientize_again, (gpointer) this);
337 }
340 Inkscape::Selection*
341 Dialog::_getSelection()
342 {
343 return sp_desktop_selection(SP_ACTIVE_DESKTOP);
344 }
346 void
347 Dialog::_apply()
348 {
349 g_warning("Apply button clicked for dialog [Dialog::_apply()]");
350 }
352 void
353 Dialog::_close()
354 {
355 GtkWidget *dlg = GTK_WIDGET(gobj());
357 /* this code sends a delete_event to the dialog,
358 * instead of just destroying it, so that the
359 * dialog can do some housekeeping, such as remember
360 * its position.
361 */
362 GdkEventAny event;
363 event.type = GDK_DELETE;
364 event.window = dlg->window;
365 event.send_event = TRUE;
366 g_object_ref (G_OBJECT (event.window));
367 gtk_main_do_event ((GdkEvent*)&event);
368 g_object_unref (G_OBJECT (event.window));
369 }
371 } // namespace Dialog
372 } // namespace UI
373 } // namespace Inkscape
375 /*
376 Local Variables:
377 mode:c++
378 c-file-style:"stroustrup"
379 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
380 indent-tabs-mode:nil
381 fill-column:99
382 End:
383 */
384 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :