GtkCRNDocument.h

Go to the documentation of this file.

/* Copyright 2010-2016 CoReNum, INSA-Lyon
 * 
 * This file is part of libgtkcrnmm.
 * 
 * libgtkcrnmm is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * libgtkcrnmm 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with libgtkcrnmm.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * file: GtkCRNDocument.h
 * \author Yann LEYDIER
 */

#ifndef GtkCRNDocument_HEADER
#define GtkCRNDocument_HEADER

#include <gtkmm.h>
#include <GtkCRNImage.h>
#include <CRNDocument.h>
#include <GtkCRNSelectionBox.h>
#include <CRNUtils/CRNProgress.h>

namespace GtkCRN
{
    class Document: 
#ifdef CRN_USING_GTKMM3
        public Gtk::Paned
#else
        public Gtk::HPaned
#endif
    {
        public:
            Document(bool show_views = true, bool show_tree = true);
            virtual ~Document() override;

            // General document management

            void set_document(const crn::SDocument &doc);
            const crn::SDocument& get_document() { return crndoc; }
            crn::SCDocument get_document() const { return crndoc; }

            // Views

            std::vector<crn::String> get_selected_views_ids();
            crn::String get_selected_view_id();
            void set_selected_view(const crn::String &view_id);

            void set_show_thumbnails(bool s);
            void set_show_labels(bool s);
            void set_show_indexes(bool s);

            void select_even();
            void select_odd();
            void select_all();
            void deselect_all();
            void invert_selection();
            void delete_selection();

            /* !\brief Opens a dialog to add views */
            void append_views_dialog();
            void append_views(const std::vector<crn::Path> &filenames);
            void refresh_views();

            void select_first();
            void select_previous();
            void select_next();
            void select_last();

            void set_default_drop_in(bool b) { droppedin_handle->block(!b); }
            sigc::signal<void, int, crn::StringUTF8> signal_droppedin() { return view_box.signal_droppedin(); }

            sigc::signal<void, const crn::String, const std::vector<crn::String> > signal_view_selection_changed() { return selection_changed; } 
            
            sigc::signal<bool, const std::vector<crn::String> > signal_delete_selection() { return may_delete_selection; }

#ifdef CRN_USING_GTKMM3

            Glib::RefPtr<Gio::SimpleActionGroup>& get_views_actions() { return views_actions;}
#else

            Glib::RefPtr<Gtk::ActionGroup>& get_views_actions() { return views_actions;}
#endif

            // Subblock tree

            const crn::SBlock& get_selected_block() { return blocksel; }
            crn::SCBlock get_selected_block() const { return blocksel; }

            void set_show_subblocks(bool s) { tree_frame.set_visible(s); }
            bool get_show_subblocks() const { return tree_frame.get_visible(); }
            void set_show_subblocks_toolbar(bool s) { tree_buttons.set_visible(s); }
            bool get_show_subblocks_toolbar() const { return tree_buttons.get_visible(); }

#ifdef CRN_USING_GTKMM3

            Glib::RefPtr<Gio::SimpleActionGroup>& get_subblock_actions() { return tree_actions;}
#else

            Glib::RefPtr<Gtk::ActionGroup>& get_subblock_actions() { return tree_actions;}
#endif

            // Displayed image

            GtkCRN::Image& get_image() { return img; }
            const GtkCRN::Image& get_image() const { return img; }

            void reload_image(const crn::String &view_id);
            void thread_safe_reload_image(const crn::String &view_id);

            void set_selection_colors(const crn::pixel::RGB8 &col1, const crn::pixel::RGB8 &col2);
            void set_subblocks_colors(const crn::pixel::RGB8 &col1, const crn::pixel::RGB8 &col2, const crn::pixel::RGB8 &textcol);
            void set_show_subblock_labels(bool s);
            bool get_show_subblock_labels() const { return show_subblock_labels; }

            // Custom panels

            Gtk::Box& get_left_panel() { return left_box; }
            Gtk::Box& get_right_panel() { return right_box; }

        private:
            // General document management
            crn::SDocument crndoc; 
            crn::SBlock current_block; 
#ifdef CRN_USING_HARU

            void export_pdf();
#endif

            // Views

#ifdef CRN_USING_GTKMM3
            Glib::RefPtr<Gio::SimpleActionGroup> views_actions;
#else
            Glib::RefPtr<Gtk::ActionGroup> views_actions;
#endif

            void create_view_cache(crn::Progress *pw);

            struct DVI
            {
                DVI(Document *d, const crn::String &vi):doc(d),id(vi) {}
                Document *doc;
                crn::String id;
            };
            static gboolean tsreloadimage(DVI *data);

            sigc::signal<void, const crn::String, const std::vector<crn::String> > selection_changed; 
            sigc::signal<void, int, crn::StringUTF8>::iterator droppedin_handle; 
            sigc::signal<bool, const std::vector<crn::String> > may_delete_selection; 
            void droppedin(int pos, crn::StringUTF8 data);
            void moved(std::vector<size_t> to, std::vector<size_t> from);
            void on_view_selection_changed(Gtk::Widget *last_selected_widget, const std::vector<Gtk::Widget*> selection);
            bool boxkeyevents(GdkEventKey *ev);

            class View: public Gtk::VBox
            {
                public:
                    View(const crn::String &id, crn::SDocument doc);
                    const crn::String& get_view_id() const { return view_id; }
                    void set_show_thumbnail(bool s) { if (s) thumb.show(); else thumb.hide(); }
                    void set_thumbnail(const crn::Path &fname) { thumb.set(fname.CStr()); }
                    void set_show_label(bool s) { if (s) lab.show(); else lab.hide(); }
                    void set_show_index(bool s) { if (s) index.show(); else index.hide(); }
                    void set_index(size_t i) { index.set_text(crn::StringUTF8(i).CStr()); }
                private:
                    Gtk::Image thumb;
                    Gtk::Label lab;
                    Gtk::Label index;
                    crn::String view_id;
            };
            SelectionBox view_box; 
            Gtk::Frame view_frame; 
            std::vector<std::shared_ptr<View> > views; 
            bool show_thumbnails, show_labels, show_indexes; 
            // Subblock tree
            Gtk::ScrolledWindow tree_sw; 
            Gtk::VBox tree_box; 
            Gtk::Toolbar tree_buttons; 
#ifdef CRN_USING_GTKMM3
            Glib::RefPtr<Gio::SimpleActionGroup> tree_actions; 
#else
            Glib::RefPtr<Gtk::ActionGroup> tree_actions; 
#endif

            class SubblockColumns : public Gtk::TreeModelColumnRecord
            {
                public:
                    SubblockColumns() { add(name); add(block); add(is_tree); add(coords); }

                    Gtk::TreeModelColumn<Glib::ustring> name; 
                    Gtk::TreeModelColumn<crn::SBlock> block; 
                    Gtk::TreeModelColumn<bool> is_tree; 
                    Gtk::TreeModelColumn<Glib::ustring> coords; 
            };
            SubblockColumns block_columns; 
            Glib::RefPtr<Gtk::TreeStore> block_tree_store; 
            Gtk::TreeView block_tree_view; 
            crn::SBlock blocksel; 
            void clear_tree();
            void load_tree(const crn::String &view_id);
            void tree_add_children(Gtk::TreeModel::iterator &it, crn::SBlock b);
            void subblock_selection_changed();
            void add_subblock();
            void rem_subblock();
            void configure_subblocks();

            // Displayed image
            Image img; 
            void on_image_overlay_changed(crn::String overlay_id, crn::String overlay_item_id, Image::MouseMode mm);
            void show_hide_subblocks_on_image();
            static const crn::String subblock_list_name; 
            crn::pixel::RGB8 treecol1, treecol2, treetextcol, selcol1, selcol2; 
            bool show_subblock_labels; 
            bool fill_subblocks; 
            // Layout widgets
#ifdef CRN_USING_GTKMM3
            Gtk::Box left_box, right_box; 
            Gtk::Paned vpan;
            Gtk::Box image_box;
#else
            Gtk::VBox left_box, right_box; 
            Gtk::VPaned vpan;
            Gtk::HBox image_box;
#endif
            Gtk::Frame tree_frame;
    };
}

#endif