src/gigedit/MacroEditor.h

/*
    Copyright (c) MMXVII Christian Schoenebeck

    This file is part of "gigedit" and released under the terms of the
    GNU General Public License version 2.
*/

#ifndef GIGEDIT_MACROEDITOR_H
#define GIGEDIT_MACROEDITOR_H

#ifdef LIBGIG_HEADER_FILE
# include LIBGIG_HEADER_FILE(gig.h)
# include LIBGIG_HEADER_FILE(Serialization.h)
#else
# include <gig.h>
# include <Serialization.h>
#endif

#include <gtkmm.h>
#if HAVE_CONFIG_H
# include <config.h>
#endif
#include "compat.h"
#include <gtkmm/uimanager.h>
#include <gtkmm/actiongroup.h>
#include "ManagedWindow.h"

/** @brief Editor for gigedit macros.
 *
 * Implements a window which allows to edit the abstract tree of one macro
 * that may be applied with gigedit.
 */
class MacroEditor : public ManagedWindow {
public:
    MacroEditor();
   ~MacroEditor();
    void setMacro(Serialization::Archive* macro, bool isClipboard);

    sigc::signal<void>& signal_changes_applied();

    // implementation for abstract methods of interface class "ManagedWindow"
    virtual Settings::Property<int>* windowSettingX() { return &Settings::singleton()->macroEditorWindowX; }
    virtual Settings::Property<int>* windowSettingY() { return &Settings::singleton()->macroEditorWindowY; }
    virtual Settings::Property<int>* windowSettingWidth() { return &Settings::singleton()->macroEditorWindowW; }
    virtual Settings::Property<int>* windowSettingHeight() { return &Settings::singleton()->macroEditorWindowH; }

protected:
    Serialization::Archive* m_macroOriginal;
    Serialization::Archive  m_macro;

    sigc::signal<void> m_changes_applied;

    Gtk::VBox m_vbox;
    Gtk::HBox m_footerHBox;
    Gtk::HBox m_statusHBox;
    Gtk::HButtonBox m_buttonBoxL;
    Gtk::HButtonBox m_buttonBox;
    Gtk::ScrolledWindow m_scrolledWindow;
    //Gtk::Label m_labelIntro;

    class ComboOptionsModel : public Gtk::TreeModel::ColumnRecord {
    public:
        ComboOptionsModel() {
            add(m_col_choice);
        }

        Gtk::TreeModelColumn<Glib::ustring> m_col_choice;
    } m_comboOptionsModel;

    class MacroModel : public Gtk::TreeModel::ColumnRecord {
    public:
        MacroModel() {
            add(m_col_name);
            add(m_col_type);
            add(m_col_value);
            add(m_col_uid);
            add(m_col_allowTextEntry);
            add(m_col_editable);
            add(m_col_options);
        }

        Gtk::TreeModelColumn<Glib::ustring> m_col_name;
        Gtk::TreeModelColumn<Glib::ustring> m_col_type;
        Gtk::TreeModelColumn<Glib::ustring> m_col_value;
        Gtk::TreeModelColumn<Serialization::UID> m_col_uid;
        Gtk::TreeModelColumn<bool> m_col_allowTextEntry;
        Gtk::TreeModelColumn<bool> m_col_editable;
        Gtk::TreeModelColumn<Glib::RefPtr<Gtk::ListStore> > m_col_options;
    } m_treeModelMacro;

    class MacroTreeStore : public Gtk::TreeStore {
    public:
        static Glib::RefPtr<MacroTreeStore> create(const MacroModel& columns) {
            return Glib::RefPtr<MacroTreeStore>( new MacroTreeStore(columns) );
        }
    protected:
        MacroTreeStore(const MacroModel& columns) : Gtk::TreeStore(columns) {}
    };

    Gtk::TreeView m_treeViewMacro;
    Glib::RefPtr<MacroTreeStore> m_treeStoreMacro;
    Gtk::CellRendererCombo m_valueCellRenderer;
    Glib::RefPtr<Gtk::ListStore> m_comboBoxModel;
    bool m_ignoreTreeViewValueChange;

    Gtk::Label m_statusLabel;
    Gtk::Button m_deleteButton;
    Gtk::Button m_inverseDeleteButton;
    Gtk::Button m_applyButton;
    Gtk::Button m_cancelButton;

    bool m_altKeyDown;
    bool m_primaryKeyDown; // on Mac: Cmd key, on all other OSs: Ctrl key

    bool isModified() const;
    void onButtonCancel();
    void onButtonApply();
    void onWindowHide();
    bool onWindowDelete(GdkEventAny* e);
    void updateStatus();
    void updateStatusBar();
    void reloadTreeView();
    void buildTreeView(const Gtk::TreeModel::Row& parentRow, const Serialization::Object& parentObject);
    void onTreeViewSelectionChanged();
    void onMacroTreeViewKeyRelease(GdkEventKey* button);
    void onMacroTreeViewRowValueChanged(const Gtk::TreeModel::Path& path,
                                        const Gtk::TreeModel::iterator& iter);
    void onMacroTreeViewRowValueChangedImpl(const Gtk::TreeModel::Path& path,
                                            const Gtk::TreeModel::iterator& iter,
                                            const Glib::ustring& value);
    void onValueCellEdited(const Glib::ustring& sPath, const Glib::ustring& text);
    void deleteSelectedRows();
    void inverseDeleteSelectedRows();
    void deleteRows(const std::vector<Gtk::TreeModel::Path>& rows);
    bool onKeyPressed(GdkEventKey* key);
    bool onKeyReleased(GdkEventKey* key);
    Glib::RefPtr<Gtk::ListStore> createComboOptions(const char** options);
};

#endif // GIGEDIT_MACROEDITOR_H
1	schoenebeck	3151	/*
2			Copyright (c) MMXVII 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 GIGEDIT_MACROEDITOR_H
9			#define GIGEDIT_MACROEDITOR_H
10
11			#ifdef LIBGIG_HEADER_FILE
12			# include LIBGIG_HEADER_FILE(gig.h)
13			# include LIBGIG_HEADER_FILE(Serialization.h)
14			#else
15			# include <gig.h>
16			# include <Serialization.h>
17			#endif
18
19			#include <gtkmm.h>
20			#if HAVE_CONFIG_H
21			# include <config.h>
22			#endif
23			#include "compat.h"
24			#include <gtkmm/uimanager.h>
25			#include <gtkmm/actiongroup.h>
26			#include "ManagedWindow.h"
27
28	schoenebeck	3157	/** @brief Editor for gigedit macros.
29			*
30			* Implements a window which allows to edit the abstract tree of one macro
31			* that may be applied with gigedit.
32			*/
33	schoenebeck	3151	class MacroEditor : public ManagedWindow {
34			public:
35			MacroEditor();
36			~MacroEditor();
37	schoenebeck	3162	void setMacro(Serialization::Archive* macro, bool isClipboard);
38	schoenebeck	3151
39	schoenebeck	3162	sigc::signal<void>& signal_changes_applied();
40
41	schoenebeck	3151	// implementation for abstract methods of interface class "ManagedWindow"
42			virtual Settings::Property<int>* windowSettingX() { return &Settings::singleton()->macroEditorWindowX; }
43			virtual Settings::Property<int>* windowSettingY() { return &Settings::singleton()->macroEditorWindowY; }
44			virtual Settings::Property<int>* windowSettingWidth() { return &Settings::singleton()->macroEditorWindowW; }
45			virtual Settings::Property<int>* windowSettingHeight() { return &Settings::singleton()->macroEditorWindowH; }
46
47			protected:
48			Serialization::Archive* m_macroOriginal;
49			Serialization::Archive m_macro;
50
51	schoenebeck	3162	sigc::signal<void> m_changes_applied;
52
53	schoenebeck	3151	Gtk::VBox m_vbox;
54			Gtk::HBox m_footerHBox;
55			Gtk::HBox m_statusHBox;
56	schoenebeck	3154	Gtk::HButtonBox m_buttonBoxL;
57	schoenebeck	3151	Gtk::HButtonBox m_buttonBox;
58			Gtk::ScrolledWindow m_scrolledWindow;
59	schoenebeck	3162	//Gtk::Label m_labelIntro;
60	schoenebeck	3151
61	schoenebeck	3170	class ComboOptionsModel : public Gtk::TreeModel::ColumnRecord {
62			public:
63			ComboOptionsModel() {
64			add(m_col_choice);
65			}
66
67			Gtk::TreeModelColumn<Glib::ustring> m_col_choice;
68			} m_comboOptionsModel;
69
70	schoenebeck	3151	class MacroModel : public Gtk::TreeModel::ColumnRecord {
71			public:
72			MacroModel() {
73			add(m_col_name);
74			add(m_col_type);
75			add(m_col_value);
76			add(m_col_uid);
77	schoenebeck	3170	add(m_col_allowTextEntry);
78			add(m_col_editable);
79			add(m_col_options);
80	schoenebeck	3151	}
81
82			Gtk::TreeModelColumn<Glib::ustring> m_col_name;
83			Gtk::TreeModelColumn<Glib::ustring> m_col_type;
84			Gtk::TreeModelColumn<Glib::ustring> m_col_value;
85			Gtk::TreeModelColumn<Serialization::UID> m_col_uid;
86	schoenebeck	3170	Gtk::TreeModelColumn<bool> m_col_allowTextEntry;
87			Gtk::TreeModelColumn<bool> m_col_editable;
88			Gtk::TreeModelColumn<Glib::RefPtr<Gtk::ListStore> > m_col_options;
89	schoenebeck	3151	} m_treeModelMacro;
90
91			class MacroTreeStore : public Gtk::TreeStore {
92			public:
93			static Glib::RefPtr<MacroTreeStore> create(const MacroModel& columns) {
94			return Glib::RefPtr<MacroTreeStore>( new MacroTreeStore(columns) );
95			}
96			protected:
97			MacroTreeStore(const MacroModel& columns) : Gtk::TreeStore(columns) {}
98			};
99
100			Gtk::TreeView m_treeViewMacro;
101			Glib::RefPtr<MacroTreeStore> m_treeStoreMacro;
102	schoenebeck	3170	Gtk::CellRendererCombo m_valueCellRenderer;
103			Glib::RefPtr<Gtk::ListStore> m_comboBoxModel;
104	schoenebeck	3154	bool m_ignoreTreeViewValueChange;
105	schoenebeck	3151
106			Gtk::Label m_statusLabel;
107	schoenebeck	3154	Gtk::Button m_deleteButton;
108			Gtk::Button m_inverseDeleteButton;
109	schoenebeck	3151	Gtk::Button m_applyButton;
110			Gtk::Button m_cancelButton;
111
112	schoenebeck	3155	bool m_altKeyDown;
113	schoenebeck	3170	bool m_primaryKeyDown; // on Mac: Cmd key, on all other OSs: Ctrl key
114	schoenebeck	3155
115	schoenebeck	3151	bool isModified() const;
116			void onButtonCancel();
117			void onButtonApply();
118			void onWindowHide();
119			bool onWindowDelete(GdkEventAny* e);
120			void updateStatus();
121			void updateStatusBar();
122			void reloadTreeView();
123			void buildTreeView(const Gtk::TreeModel::Row& parentRow, const Serialization::Object& parentObject);
124	schoenebeck	3154	void onTreeViewSelectionChanged();
125			void onMacroTreeViewKeyRelease(GdkEventKey* button);
126			void onMacroTreeViewRowValueChanged(const Gtk::TreeModel::Path& path,
127			const Gtk::TreeModel::iterator& iter);
128	schoenebeck	3170	void onMacroTreeViewRowValueChangedImpl(const Gtk::TreeModel::Path& path,
129			const Gtk::TreeModel::iterator& iter,
130			const Glib::ustring& value);
131			void onValueCellEdited(const Glib::ustring& sPath, const Glib::ustring& text);
132	schoenebeck	3154	void deleteSelectedRows();
133			void inverseDeleteSelectedRows();
134	schoenebeck	3155	void deleteRows(const std::vector<Gtk::TreeModel::Path>& rows);
135			bool onKeyPressed(GdkEventKey* key);
136			bool onKeyReleased(GdkEventKey* key);
137	schoenebeck	3170	Glib::RefPtr<Gtk::ListStore> createComboOptions(const char** options);
138	schoenebeck	3151	};
139
140			#endif // GIGEDIT_MACROEDITOR_H