canvas-grid.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Author:
 *   Tavmjong Bah
 *
 * Copyright (C) 2020 Tavmjong Bah
 *
 * Released under GNU GPL v2+, read the file 'COPYING' for more information.
 */
 
#ifndef INKSCAPE_UI_WIDGET_CANVASGRID_H
#define INKSCAPE_UI_WIDGET_CANVASGRID_H
 
#include <memory>
#include <2geom/point.h>
#include <2geom/int-point.h>
#include <gtkmm/gesture.h> // Gtk::EventSequenceState
#include <gtkmm/grid.h>
#include <gtkmm/menubutton.h>
#include <gtkmm/overlay.h>
#include <gtkmm/scrollbar.h>
#include <gtkmm/togglebutton.h>
#include <gtkmm/label.h>
 
#include "display/control/canvas-item-ptr.h"
#include "preferences.h"
#include <sigc++/scoped_connection.h>
#include "ui/widget/popover-bin.h"
#include "util/action-accel.h"
 
namespace Gtk {
class Adjustment;
class Builder;
class CheckButton;
class EventControllerMotion;
class GestureClick;
} // namespace Gtk
 
class SPDesktop;
class SPDocument;
class SPDesktopWidget;
 
namespace Inkscape {
 
struct MotionEvent;
class CanvasItemGuideLine;
 
namespace UI {
 
namespace Dialog {
class CommandPalette;
} // namespace Dialog
 
namespace Widget {
 
class Canvas;
class CanvasNotice;
class Ruler;
class Stack;
class TabsWidget;
 
class CanvasGrid : public Gtk::Grid
{
    using parent_type = Gtk::Grid;
 
public:
    CanvasGrid(SPDesktopWidget *dtw);
    ~CanvasGrid() override;
 
    void ShowScrollbars(bool state = true);
    void ToggleScrollbars();
 
    void ShowRulers(bool state = true);
    void ToggleRulers();
    void updateRulers();
 
    void ShowCommandPalette(bool state = true);
    void ToggleCommandPalette();
 
    void showNotice(Glib::ustring const &msg, int timeout = 0);
 
    void setPopover(Gtk::Popover *popover) { _popoverbin.setPopover(popover); }
 
    void addTab(Canvas *canvas);
    void removeTab(Canvas *canvas);
    void switchTab(Canvas *canvas);
 
    Canvas *GetCanvas() { return _canvas; };
 
    // Hopefully temp.
    Inkscape::UI::Widget::Ruler *GetHRuler() { return _vruler.get(); };
    Inkscape::UI::Widget::Ruler *GetVRuler() { return _hruler.get(); };
    Gtk::Adjustment *GetHAdj() { return _hadj.get(); };
    Gtk::Adjustment *GetVAdj() { return _vadj.get(); };
    Gtk::ToggleButton *GetGuideLock()  { return &_guide_lock; }
    Gtk::ToggleButton *GetCmsAdjust()  { return &_cms_adjust; }
    Gtk::CheckButton  *GetStickyZoom();
    Dialog::CommandPalette *getCommandPalette() { return _command_palette.get(); }
    Inkscape::UI::Widget::TabsWidget *getTabsWidget() { return _tabs_widget.get(); }
 
    // Motion event handler, and delayed snap event callback.
    void rulerMotion(MotionEvent const &event, bool horiz);
 
    // Scroll handling.
    void updateScrollbars(double scale);
 
private:
    // Signal callbacks
    void size_allocate_vfunc(int width, int height, int baseline) override;
    void on_realize() override;
 
    PrefObserver _box_observer;
 
    // The widgets
    Gtk::Label* _quick_preview_label = nullptr;
    Gtk::Label* _quick_zoom_label = nullptr;
    Inkscape::Util::ActionAccel _preview_accel{"tool.all.quick-preview"};
    Inkscape::Util::ActionAccel _zoom_accel{"tool.all.quick-zoom"};
 
    Inkscape::UI::Widget::PopoverBin _popoverbin;
    Inkscape::UI::Widget::Canvas *_canvas = nullptr;
    std::unique_ptr<Dialog::CommandPalette> _command_palette;
    CanvasNotice *_notice;
    Gtk::Overlay _canvas_overlay;
    Gtk::Grid _subgrid;
    Inkscape::UI::Widget::Stack *_canvas_stack;
    std::unique_ptr<Inkscape::UI::Widget::TabsWidget> _tabs_widget;
 
    Glib::RefPtr<Gtk::Adjustment> _hadj;
    Glib::RefPtr<Gtk::Adjustment> _vadj;
    Gtk::Scrollbar _hscrollbar;
    Gtk::Scrollbar _vscrollbar;
 
    std::unique_ptr<Inkscape::UI::Widget::Ruler> _hruler;
    std::unique_ptr<Inkscape::UI::Widget::Ruler> _vruler;
 
    Gtk::ToggleButton _guide_lock;
    Gtk::ToggleButton _cms_adjust;
    Gtk::MenuButton _quick_actions;
    Glib::RefPtr<Gtk::Builder> _builder_display_popup;
 
    // To be replaced by stateful Gio::Actions
    bool _show_scrollbars = true;
    bool _show_rulers = true;
 
    // Hopefully temp
    SPDesktopWidget *_dtw;
    SPDocument *_document = nullptr;
 
    // Store allocation so we don't redraw too often.
    int _width{}, _height{};
 
    // Connections for page and selection tracking
    sigc::scoped_connection _update_preview_connection;
    sigc::scoped_connection _update_zoom_connection;
    sigc::scoped_connection _page_selected_connection;
    sigc::scoped_connection _page_modified_connection;
    sigc::scoped_connection _sel_changed_connection;
    sigc::scoped_connection _sel_modified_connection;
    sigc::scoped_connection _blink_lock_button_timeout;
 
    // Ruler event handling.
    bool _ruler_clicked = false; 
    bool _ruler_dragged = false; 
    bool _ruler_ctrl_clicked = false; 
    Geom::IntPoint _ruler_drag_origin; 
    Geom::Point _normal; 
    CanvasItemPtr<CanvasItemGuideLine> _active_guide; 
 
    Geom::IntPoint _rulerToCanvas(bool horiz) const;
    void _createGuideItem(Geom::Point const &pos, bool horiz);
    void _createGuide(Geom::Point origin, Geom::Point normal);
 
    enum class RulerOrientation {vertical, horizontal};
    Gtk::EventSequenceState _rulerButtonPress  (Gtk::GestureClick const &gesture,
                                                int n_press, double x, double y);
    Gtk::EventSequenceState _rulerButtonRelease(Gtk::GestureClick const &gesture,
                                                int n_press, double x, double y, RulerOrientation orientation);
    void _rulerMotion(Gtk::EventControllerMotion const &controller,
                      double x, double y, RulerOrientation orientation);
    void _blinkLockButton();
 
    // Scroll handling.
    bool _updating = false;
    void _adjustmentChanged();
};
 
} // namespace Widget
} // namespace UI
} // namespace Inkscape
 
#endif // INKSCAPE_UI_WIDGET_CANVASGRID_H
 
/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :