src/gigedit/ReferencesView.h

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

#ifndef GIGEDIT_REFERENCESVIEW_H
#define GIGEDIT_REFERENCESVIEW_H

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

#ifdef GTKMM_HEADER_FILE
# include GTKMM_HEADER_FILE(gtkmm.h)
#else
# include <gtkmm.h>
#endif
#include "wrapLabel.hh"
#include "ManagedWindow.h"

/** @brief Sample reference browser dialog.
 *
 * Shows a modal dialog with a tree view showing all instruments and their
 * respective regions which reference the selected sample at least once.
 */
class ReferencesView : public ManagedDialog {
public:
    ReferencesView(Gtk::Window& parent);
    void setSample(gig::Sample* sample);

    // When the user single clicked on a sample reference on this reference
    // view dialog, then this signal is emitted and the dimension region editor
    // shall select the respective, instrument, region and dimension region for
    // further editing. The editor shall return true if selection was successful
    // or should return false on errors.
    sigc::signal<bool, gig::DimensionRegion*> dimension_region_selected;

    // implementation for abstract methods of interface class "ManagedDialog"
    virtual Settings::Property<int>* windowSettingX() { return &Settings::singleton()->sampleRefsWindowX; }
    virtual Settings::Property<int>* windowSettingY() { return &Settings::singleton()->sampleRefsWindowY; }
    virtual Settings::Property<int>* windowSettingWidth() { return &Settings::singleton()->sampleRefsWindowW; }
    virtual Settings::Property<int>* windowSettingHeight() { return &Settings::singleton()->sampleRefsWindowH; }

protected:
    gig::Sample* m_sample;

    HButtonBox      m_buttonBox;
    Gtk::ScrolledWindow  m_scrolledWindow;
    Gtk::TreeView        m_treeView;
    Gtk::Button          m_closeButton;
#if GTKMM_MAJOR_VERSION < 3
    view::WrapLabel      m_descriptionLabel;
#else
    Gtk::Label           m_descriptionLabel;
#endif
#if GTKMM_MAJOR_VERSION < 3
    view::WrapLabel      m_summaryLabel;
#else
    Gtk::Label           m_summaryLabel;
#endif

    class RefsTreeModel : public Gtk::TreeModel::ColumnRecord {
    public:
        RefsTreeModel() {
            add(m_col_name);
            add(m_col_instr);
            add(m_col_region);
            add(m_col_refcount);
        }

        Gtk::TreeModelColumn<Glib::ustring>    m_col_name;
        Gtk::TreeModelColumn<gig::Instrument*> m_col_instr;
        Gtk::TreeModelColumn<gig::Region*>     m_col_region;
        Gtk::TreeModelColumn<Glib::ustring>    m_col_refcount;
    } m_columns;

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

    Glib::RefPtr<RefsTreeStore>  m_refTreeModel;

    void onSelectionChanged(const Gtk::TreeModel::Path& path, Gtk::TreeViewColumn* column);
};

#endif // GIGEDIT_REFERENCESVIEW_H
1	schoenebeck	2624	/*
2	schoenebeck	3068	Copyright (c) 2014-2017 Christian Schoenebeck
3	schoenebeck	2624
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_REFERENCESVIEW_H
9			#define GIGEDIT_REFERENCESVIEW_H
10
11	schoenebeck	3068	#ifdef LIBGIG_HEADER_FILE
12			# include LIBGIG_HEADER_FILE(gig.h)
13			#else
14			# include <gig.h>
15			#endif
16
17	schoenebeck	3364	#ifdef GTKMM_HEADER_FILE
18			# include GTKMM_HEADER_FILE(gtkmm.h)
19			#else
20			# include <gtkmm.h>
21			#endif
22	schoenebeck	2624	#include "wrapLabel.hh"
23	schoenebeck	2894	#include "ManagedWindow.h"
24	schoenebeck	2624
25			/** @brief Sample reference browser dialog.
26			*
27			* Shows a modal dialog with a tree view showing all instruments and their
28			* respective regions which reference the selected sample at least once.
29			*/
30	schoenebeck	2894	class ReferencesView : public ManagedDialog {
31	schoenebeck	2624	public:
32			ReferencesView(Gtk::Window& parent);
33			void setSample(gig::Sample* sample);
34	schoenebeck	2695
35			// When the user single clicked on a sample reference on this reference
36			// view dialog, then this signal is emitted and the dimension region editor
37			// shall select the respective, instrument, region and dimension region for
38			// further editing. The editor shall return true if selection was successful
39			// or should return false on errors.
40			sigc::signal<bool, gig::DimensionRegion*> dimension_region_selected;
41
42	schoenebeck	2894	// implementation for abstract methods of interface class "ManagedDialog"
43			virtual Settings::Property<int>* windowSettingX() { return &Settings::singleton()->sampleRefsWindowX; }
44			virtual Settings::Property<int>* windowSettingY() { return &Settings::singleton()->sampleRefsWindowY; }
45			virtual Settings::Property<int>* windowSettingWidth() { return &Settings::singleton()->sampleRefsWindowW; }
46			virtual Settings::Property<int>* windowSettingHeight() { return &Settings::singleton()->sampleRefsWindowH; }
47
48	schoenebeck	2624	protected:
49			gig::Sample* m_sample;
50
51	schoenebeck	3364	HButtonBox m_buttonBox;
52	schoenebeck	2624	Gtk::ScrolledWindow m_scrolledWindow;
53			Gtk::TreeView m_treeView;
54			Gtk::Button m_closeButton;
55			#if GTKMM_MAJOR_VERSION < 3
56			view::WrapLabel m_descriptionLabel;
57			#else
58			Gtk::Label m_descriptionLabel;
59			#endif
60			#if GTKMM_MAJOR_VERSION < 3
61			view::WrapLabel m_summaryLabel;
62			#else
63			Gtk::Label m_summaryLabel;
64			#endif
65
66			class RefsTreeModel : public Gtk::TreeModel::ColumnRecord {
67			public:
68			RefsTreeModel() {
69			add(m_col_name);
70			add(m_col_instr);
71			add(m_col_region);
72			add(m_col_refcount);
73			}
74
75			Gtk::TreeModelColumn<Glib::ustring> m_col_name;
76			Gtk::TreeModelColumn<gig::Instrument*> m_col_instr;
77			Gtk::TreeModelColumn<gig::Region*> m_col_region;
78			Gtk::TreeModelColumn<Glib::ustring> m_col_refcount;
79			} m_columns;
80
81			class RefsTreeStore : public Gtk::TreeStore {
82			public:
83			static Glib::RefPtr<RefsTreeStore> create(const RefsTreeModel& columns) {
84			return Glib::RefPtr<RefsTreeStore>( new RefsTreeStore(columns) );
85			}
86			protected:
87			RefsTreeStore(const RefsTreeModel& columns) : Gtk::TreeStore(columns) {}
88			};
89
90			Glib::RefPtr<RefsTreeStore> m_refTreeModel;
91	schoenebeck	2695
92	schoenebeck	3340	void onSelectionChanged(const Gtk::TreeModel::Path& path, Gtk::TreeViewColumn* column);
93	schoenebeck	2624	};
94
95			#endif // GIGEDIT_REFERENCESVIEW_H