dialog-base.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-or-later
#ifndef INK_DIALOG_BASE_H
#define INK_DIALOG_BASE_H
 
#include <gtkmm/box.h>
 
#include "inkscape-application.h"
 
namespace Gtk {
class EventControllerKey;
class ScrolledWindow;
} // namespace Gtk
 
class SPDesktop;
 
namespace Inkscape::UI::Dialog {
 
class DialogBase : public Gtk::Box
{
    using parent_type = Gtk::Box;
 
public:
    DialogBase(char const *prefs_path = nullptr, Glib::ustring dialog_type = {});
    DialogBase(DialogBase const &) = delete;
    DialogBase &operator=(DialogBase const &) = delete;
    ~DialogBase() override;
 
    virtual void update() {}
 
    // Public for future use, say if the desktop is smartly set when docking dialogs.
    void setDesktop(SPDesktop *new_desktop);
 
    void on_map() override;
 
    Glib::ustring const &get_name    () const { return _name       ; }
    Glib::ustring const &getPrefsPath() const { return _prefs_path ; }
    Glib::ustring const &get_type    () const { return _dialog_type; }
    const Glib::ustring& get_icon() const { return _icon_name; }
 
    void blink();
    // find focusable widget to grab focus
    virtual void focus_dialog();
    // return focus back to canvas
    void defocus_dialog();
    bool getShowing() { return _showing; }
    // fix children scrolled windows to send outer scroll when his own reach limits
    void fix_inner_scroll(Gtk::ScrolledWindow &scrollwin);
 
    // Too many dialogs have unprotected calls to ask for this data
    SPDesktop *getDesktop() const { return desktop; }
 
protected:
    InkscapeApplication *getApp() const { return _app; }
    SPDocument *getDocument() const { return document; }
    Selection *getSelection() const { return selection; }
    friend class DialogNotebook;
    void setShowing(bool showing);
    Glib::ustring _name;             // Gtk widget name (must be set!)
    Glib::ustring const _prefs_path; // Stores characteristic path for loading/saving the dialog position.
    Glib::ustring const _dialog_type; // Type of dialog (we could just use _pref_path?).
 
private:
    bool blink_off(); // timer callback
    bool on_key_pressed(Gtk::EventControllerKey const &controller,
                        unsigned keyval, unsigned keycode, Gdk::ModifierType state);
    // return if dialog is on visible tab
    bool _showing = true;
    void unsetDesktop();
    void desktopDestroyed(SPDesktop* old_desktop);
    void setDocument(SPDocument *new_document);
    virtual void desktopReplaced() {}
    virtual void documentReplaced() {}
    virtual void selectionChanged(Inkscape::Selection *selection) {};
    virtual void selectionModified(Inkscape::Selection *selection, guint flags) {};
 
    sigc::connection _desktop_destroyed;
    sigc::connection _doc_replaced;
    sigc::connection _select_changed;
    sigc::connection _select_modified;
 
    int _modified_flags = 0;
    bool _modified_while_hidden = false;
    bool _changed_while_hidden = false;
 
    InkscapeApplication *_app; // Used for state management
    SPDesktop  *desktop   = nullptr;
    SPDocument *document  = nullptr;
    Selection  *selection = nullptr;
    Glib::ustring _icon_name;
};
 
} // namespace Inkscape::UI::Dialog
 
#endif // INK_DIALOG_BASE_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 :