summaryrefslogtreecommitdiffstats
path: root/src/extension/prefdialog.h
blob: 0a10881d6889d4de120356ca86342e9549598d14 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/*
 * Authors:
 *   Ted Gould <ted@gould.cx>
 *
 * Copyright (C) 2005,2007-2008 Authors
 *
 * Released under GNU GPL, read the file 'COPYING' for more information
 */

#ifndef INKSCAPE_EXTENSION_DIALOG_H__
#define INKSCAPE_EXTENSION_DIALOG_H__

#include <glibmm/ustring.h>

#include <gdkmm/types.h>

#include <gtkmm/dialog.h>
#include <gtkmm/checkbutton.h>
#include <gtkmm/socket.h>

#include "execution-env.h"
#include "param/parameter.h"

namespace Inkscape {
namespace Extension {

/** \brief  A class to represent the preferences for an extension */
class PrefDialog : public Gtk::Dialog {
    /** \brief  Help string if it exists */
    gchar const * _help;
    /** \brief  Name of the extension */
    Glib::ustring _name;

    /** \brief  A pointer to the OK button */
    Gtk::Button * _button_ok;
    /** \brief  A pointer to the CANCEL button */
    Gtk::Button * _button_cancel;

    /** \brief  Button to control live preview */
    Gtk::Widget * _button_preview;
    /** \brief  Checkbox for the preview */
    Gtk::CheckButton * _checkbox_preview;

    /** \brief  Parameter to control live preview */
    Parameter * _param_preview;

    /** \brief  XML to define the live effects parameter on the dialog */
    static const char * live_param_xml;

    /** \brief Signal that the user is changing the live effect state */
    sigc::signal<void> _signal_preview;
    /** \brief Signal that one of the parameters change */
    sigc::signal<void> _signal_param_change;

    /** \brief  If this is the preferences for an effect, the effect
                that we're working with. */
    Effect * _effect;
    /** \brief  If we're executing in preview mode here is the execution
                environment for the effect. */
    ExecutionEnv * _exEnv;

    /** \brief  The timer used to make it so that parameters don't respond
                directly and allows for changes. */
    sigc::connection _timersig;

    void preview_toggle(void);
    void param_change(void);
    bool param_timer_expire(void);
    void on_response (int signal);

public:
    PrefDialog (Glib::ustring name,
                gchar const * help,
                Gtk::Widget * controls = NULL,
                Effect * effect = NULL);
    virtual ~PrefDialog ();
};


};}; /* namespace Inkscape, Extension */

#endif /* INKSCAPE_EXTENSION_DIALOG_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 :