src/gigedit/ManagedWindow.h

/*
    Copyright (c) 2016 - 2017 Christian Schoenebeck
    
    This file is part of "gigedit" and released under the terms of the
    GNU General Public License version 2.
*/

#ifndef MANAGED_WINDOW_H
#define MANAGED_WINDOW_H

#include "compat.h"
#include <glibmm/object.h>
#include <gtkmm/window.h>
#if USE_GTKMM_BUILDER
# include <gtkmm/applicationwindow.h>
#endif
#include <gtkmm/dialog.h>
#include <glibmm/main.h>
#include "Settings.h"

/** @brief Base class intended to be used for all gigedit Windows.
 *
 * This class aims to provide common functionalities for all Windows of the
 * gigedit application. So usually all gigedit Windows should derive from this
 * class.
 *
 * Currently this class only automatically saves and restores the user's
 * preference for the respective Windows position on the screen and size of the
 * window. It saves the position and dimensions automatically as soon as the
 * user moves or resizes the window. And it automatically restores the window's
 * position and size when it is created.
 */
class ManagedWindow :
#if USE_GTKMM_BUILDER
    public Gtk::ApplicationWindow
#else
    public Gtk::Window
#endif
{
public:
    ManagedWindow();

    // following methods must be implemented by deriving class
    virtual Settings::Property<int>* windowSettingX() = 0;
    virtual Settings::Property<int>* windowSettingY() = 0;
    virtual Settings::Property<int>* windowSettingWidth() = 0;
    virtual Settings::Property<int>* windowSettingHeight() = 0;

protected:
#if GTKMM_MAJOR_VERSION > 3 || (GTKMM_MAJOR_VERSION == 3 && (GTKMM_MINOR_VERSION > 91 || (GTKMM_MINOR_VERSION == 91 && GTKMM_MICRO_VERSION >= 2))) // GTKMM >= 3.91.2
    bool on_configure_event(Gdk::EventConfigure& event);
#else
    bool on_configure_event(GdkEventConfigure* e);
#endif
    void enableListeningConfigureEvents() { m_listenOnConfigureEvents = true; }
    bool saveWindowDimensions(int x, int y, int w, int h);
    void restoreWindowDimensions();
private:
    Gtk::Window* m_window;
    bool m_listenOnConfigureEvents;
    Glib::RefPtr<Glib::TimeoutSource> m_eventThrottleTimer;
};

/** @brief Base class intended to be used for all gigedit dialogs.
 *
 * This class aims to provide common functionalities for all dialogs of the
 * gigedit application. So usually all gigedit dialogs should derive from this
 * class.
 *
 * This class essentially is a copy of ManagedWindow. Due to inheritance
 * issues there is unfortunately not much that could be avoided regarding code
 * duplication by using a common both class for both. That's why all code is
 * simply copied for now.
 */
class ManagedDialog : public Gtk::Dialog {
public:
    ManagedDialog();
    ManagedDialog(const Glib::ustring& title, bool modal = false);
    explicit ManagedDialog(const Glib::ustring& title, Gtk::Window& parent, bool modal = false);
    //ManagedDialog(const Glib::ustring& title, Gtk::DialogFlags flags);

    // following methods must be implemented by deriving class
    virtual Settings::Property<int>* windowSettingX() = 0;
    virtual Settings::Property<int>* windowSettingY() = 0;
    virtual Settings::Property<int>* windowSettingWidth() = 0;
    virtual Settings::Property<int>* windowSettingHeight() = 0;

protected:
#if GTKMM_MAJOR_VERSION > 3 || (GTKMM_MAJOR_VERSION == 3 && (GTKMM_MINOR_VERSION > 91 || (GTKMM_MINOR_VERSION == 91 && GTKMM_MICRO_VERSION >= 2))) // GTKMM >= 3.91.2
    bool on_configure_event(Gdk::EventConfigure& event);
#else
    bool on_configure_event(GdkEventConfigure* e);
#endif
    void enableListeningConfigureEvents() { m_listenOnConfigureEvents = true; }
    bool saveWindowDimensions(int x, int y, int w, int h);
    void restoreWindowDimensions();
    void initManagedDialog();
private:
    Gtk::Window* m_window;
    bool m_listenOnConfigureEvents;
    Glib::RefPtr<Glib::TimeoutSource> m_eventThrottleTimer;
};

#endif // MANAGED_WINDOW_H
1	/*
2	Copyright (c) 2016 - 2017 Christian Schoenebeck
3
4	This file is part of "gigedit" and released under the terms of the
5	GNU General Public License version 2.
6	*/
7
8	#ifndef MANAGED_WINDOW_H
9	#define MANAGED_WINDOW_H
10
11	#include "compat.h"
12	#include <glibmm/object.h>
13	#include <gtkmm/window.h>
14	#if USE_GTKMM_BUILDER
15	# include <gtkmm/applicationwindow.h>
16	#endif
17	#include <gtkmm/dialog.h>
18	#include <glibmm/main.h>
19	#include "Settings.h"
20
21	/** @brief Base class intended to be used for all gigedit Windows.
22	*
23	* This class aims to provide common functionalities for all Windows of the
24	* gigedit application. So usually all gigedit Windows should derive from this
25	* class.
26	*
27	* Currently this class only automatically saves and restores the user's
28	* preference for the respective Windows position on the screen and size of the
29	* window. It saves the position and dimensions automatically as soon as the
30	* user moves or resizes the window. And it automatically restores the window's
31	* position and size when it is created.
32	*/
33	class ManagedWindow :
34	#if USE_GTKMM_BUILDER
35	public Gtk::ApplicationWindow
36	#else
37	public Gtk::Window
38	#endif
39	{
40	public:
41	ManagedWindow();
42
43	// following methods must be implemented by deriving class
44	virtual Settings::Property<int>* windowSettingX() = 0;
45	virtual Settings::Property<int>* windowSettingY() = 0;
46	virtual Settings::Property<int>* windowSettingWidth() = 0;
47	virtual Settings::Property<int>* windowSettingHeight() = 0;
48
49	protected:
50	#if GTKMM_MAJOR_VERSION > 3 \|\| (GTKMM_MAJOR_VERSION == 3 && (GTKMM_MINOR_VERSION > 91 \|\| (GTKMM_MINOR_VERSION == 91 && GTKMM_MICRO_VERSION >= 2))) // GTKMM >= 3.91.2
51	bool on_configure_event(Gdk::EventConfigure& event);
52	#else
53	bool on_configure_event(GdkEventConfigure* e);
54	#endif
55	void enableListeningConfigureEvents() { m_listenOnConfigureEvents = true; }
56	bool saveWindowDimensions(int x, int y, int w, int h);
57	void restoreWindowDimensions();
58	private:
59	Gtk::Window* m_window;
60	bool m_listenOnConfigureEvents;
61	Glib::RefPtr<Glib::TimeoutSource> m_eventThrottleTimer;
62	};
63
64	/** @brief Base class intended to be used for all gigedit dialogs.
65	*
66	* This class aims to provide common functionalities for all dialogs of the
67	* gigedit application. So usually all gigedit dialogs should derive from this
68	* class.
69	*
70	* This class essentially is a copy of ManagedWindow. Due to inheritance
71	* issues there is unfortunately not much that could be avoided regarding code
72	* duplication by using a common both class for both. That's why all code is
73	* simply copied for now.
74	*/
75	class ManagedDialog : public Gtk::Dialog {
76	public:
77	ManagedDialog();
78	ManagedDialog(const Glib::ustring& title, bool modal = false);
79	explicit ManagedDialog(const Glib::ustring& title, Gtk::Window& parent, bool modal = false);
80	//ManagedDialog(const Glib::ustring& title, Gtk::DialogFlags flags);
81
82	// following methods must be implemented by deriving class
83	virtual Settings::Property<int>* windowSettingX() = 0;
84	virtual Settings::Property<int>* windowSettingY() = 0;
85	virtual Settings::Property<int>* windowSettingWidth() = 0;
86	virtual Settings::Property<int>* windowSettingHeight() = 0;
87
88	protected:
89	#if GTKMM_MAJOR_VERSION > 3 \|\| (GTKMM_MAJOR_VERSION == 3 && (GTKMM_MINOR_VERSION > 91 \|\| (GTKMM_MINOR_VERSION == 91 && GTKMM_MICRO_VERSION >= 2))) // GTKMM >= 3.91.2
90	bool on_configure_event(Gdk::EventConfigure& event);
91	#else
92	bool on_configure_event(GdkEventConfigure* e);
93	#endif
94	void enableListeningConfigureEvents() { m_listenOnConfigureEvents = true; }
95	bool saveWindowDimensions(int x, int y, int w, int h);
96	void restoreWindowDimensions();
97	void initManagedDialog();
98	private:
99	Gtk::Window* m_window;
100	bool m_listenOnConfigureEvents;
101	Glib::RefPtr<Glib::TimeoutSource> m_eventThrottleTimer;
102	};
103
104	#endif // MANAGED_WINDOW_H