prefdialog.cpp

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Authors:
 *   Ted Gould <ted@gould.cx>
 *
 * Copyright (C) 2005-2008 Authors
 *
 * Released under GNU GPL v2+, read the file 'COPYING' for more information.
 */
 
#include "prefdialog.h"
 
#include <cassert>
#include <glibmm/i18n.h>
#include <gtkmm/checkbutton.h>
#include <gtkmm/separator.h>
 
#include "document.h"
#include "document-undo.h"
#include "extension/effect.h"
#include "extension/execution-env.h"
#include "extension/implementation/implementation.h"
#include "inkscape.h" // Used to get SP_ACTIVE_DESKTOP
#include "parameter.h"
#include "ui/dialog-events.h"
#include "ui/pack.h"
#include "ui/util.h"
#include "xml/repr.h"
 
namespace Inkscape::Extension {
 
PrefDialog::PrefDialog (Glib::ustring name, Gtk::Widget * controls, Effect * effect) :
    Gtk::Dialog(name, true),
    _name(name),
    _button_ok(nullptr),
    _button_cancel(nullptr),
    _button_preview(nullptr),
    _effect(effect)
{
    this->set_default_size(0,0);  // we want the window to be as small as possible instead of clobbering up space
 
    auto hbox = Gtk::make_managed<Gtk::Box>(Gtk::Orientation::HORIZONTAL);
    if (controls == nullptr) {
        if (_effect == nullptr) {
            std::cerr << "AH!!!  No controls and no effect!!!" << std::endl;
            return;
        }
        controls = _effect->get_imp()->prefs_effect(_effect, SP_ACTIVE_DESKTOP, &_signal_param_change, nullptr);
        _signal_param_change.connect(sigc::mem_fun(*this, &PrefDialog::param_change));
    }
 
    UI::pack_start(*hbox, *controls, true, true);
    hbox->set_visible(true);
 
    UI::pack_start(*this->get_content_area(), *hbox, true, true);
 
    _button_cancel = add_button(_effect == nullptr ? _("_Cancel") : _("_Close"), Gtk::ResponseType::CANCEL);
    _button_ok     = add_button(_effect == nullptr ? _("_OK")     : _("_Apply"), Gtk::ResponseType::OK);
    set_default_response(Gtk::ResponseType::OK);
    _button_ok->grab_focus();
 
    if (_effect != nullptr && !_effect->no_live_preview) {
        if (_param_preview == nullptr) {
            XML::Document * doc = sp_repr_read_mem(live_param_xml, strlen(live_param_xml), nullptr);
            if (doc == nullptr) {
                std::cerr << "Error encountered loading live parameter XML !!!" << std::endl;
                return;
            }
 
            _param_preview.reset(InxParameter::make(doc->root(), _effect));
        }
 
        auto const sep = Gtk::make_managed<Gtk::Separator>();
        sep->set_visible(true);
        UI::pack_start(*this->get_content_area(), *sep, false, false, InxWidget::GUI_BOX_SPACING);
 
        hbox = Gtk::make_managed<Gtk::Box>(Gtk::Orientation::HORIZONTAL);
        hbox->set_margin(InxWidget::GUI_BOX_MARGIN);
        _button_preview = _param_preview->get_widget(&_signal_preview);
        _button_preview->set_visible(true);
        UI::pack_start(*hbox, *_button_preview, true, true);
        hbox->set_visible(true);
 
        UI::pack_start(*this->get_content_area(), *hbox, false, false);
 
        if (auto const preview_box =  dynamic_cast<Gtk::Box *>(_button_preview)) {
            _checkbox_preview = dynamic_cast<Gtk::CheckButton *>(UI::get_children(*preview_box).at(0));
        }
 
        preview_toggle();
        _signal_preview.connect(sigc::mem_fun(*this, &PrefDialog::preview_toggle));
    }
 
    // Set window modality for effects that don't use live preview
    if (_effect != nullptr && _effect->no_live_preview) {
        set_modal(false);
    }
}
 
PrefDialog::~PrefDialog ( )
{
    if (_exEnv != nullptr) {
        _exEnv->cancel();
    }
 
    if (_effect != nullptr) {
        _effect->set_pref_dialog(nullptr);
    }
    return;
}
 
void
PrefDialog::preview_toggle () {
    // This wrap prevent crashes on fast click
    // We are on 2 mains process so can triger a crash if you check too fast
    _button_preview->set_sensitive(false);
    SPDocument *document = SP_ACTIVE_DOCUMENT;
    bool modified = document->isModifiedSinceSave();
 
    assert(_param_preview);
    if(_param_preview->get_bool()) {
        if (_exEnv == nullptr) {
            set_modal(true);
 
            _exEnv = std::make_unique<ExecutionEnv>(_effect, SP_ACTIVE_DESKTOP, nullptr, false, false);
            _exEnv->run();
        }
    } else {
        set_modal(false);
 
        if (_exEnv != nullptr) {
            _exEnv->cancel();
            _exEnv->undo();
            _exEnv->reselect();
 
            _exEnv.reset();
        }
    }
 
    document->setModifiedSinceSave(modified);
    _button_preview->set_sensitive(true);
}
 
void
PrefDialog::param_change () {
    if (_exEnv != nullptr) {
        if (!_effect->loaded()) {
            _effect->set_state(Extension::STATE_LOADED);
        }
        _timersig.disconnect();
        _timersig = Glib::signal_timeout().connect(sigc::mem_fun(*this, &PrefDialog::param_timer_expire),
                                                   250, /* ms */
                                                   Glib::PRIORITY_DEFAULT_IDLE);
    }
 
    return;
}
 
bool
PrefDialog::param_timer_expire () {
    if (_exEnv != nullptr) {
        _exEnv->cancel();
        _exEnv->undo();
        _exEnv->reselect();
        _exEnv->run();
    }
 
    return false;
}
 
void
PrefDialog::on_response (int signal) {
    if (signal == Gtk::ResponseType::OK) {
        if (_exEnv == nullptr) {
            if (_effect != nullptr) {
                _effect->effect(SP_ACTIVE_DESKTOP);
            } else {
                // Shutdown run()
                return;
            }
        } else {
            if (_exEnv->wait()) {
                _exEnv->commit();
            } else {
                _exEnv->undo();
                _exEnv->reselect();
            }
 
            _exEnv.reset();
        }
    }
 
    if (_param_preview != nullptr) {
        _checkbox_preview->set_active(false);
    }
 
    if ((signal == Gtk::ResponseType::CANCEL || signal == Gtk::ResponseType::DELETE_EVENT) && _effect != nullptr) {
        delete this;
    }
}
 
#include "extension/internal/clear-n_.h"
 
const char * PrefDialog::live_param_xml = "<param name=\"__live_effect__\" type=\"bool\" gui-text=\"" N_("Live preview") "\" gui-description=\"" N_("Is the effect previewed live on canvas?") "\">false</param>";
 
} // namespace Inkscape::Extension
 
/*
  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 :