summaryrefslogtreecommitdiffstats
path: root/src/extension/prefdialog/param/notebook.h
blob: dd7154f0633d0ce77fd9592cc4425ee0668f0036 (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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
// SPDX-License-Identifier: GPL-2.0-or-later
#ifndef INK_EXTENSION_PARAMNOTEBOOK_H_SEEN
#define INK_EXTENSION_PARAMNOTEBOOK_H_SEEN

/** \file
 * Notebook parameter for extensions.
 */

/*
 * Author:
 *   Johan Engelen <johan@shouraizou.nl>
 *   Jon A. Cruz <jon@joncruz.org>
 *
 * Copyright (C) 2006 Author
 *
 * Released under GNU GPL v2+, read the file 'COPYING' for more information.
 */

#include "parameter.h"

namespace Gtk {
class Widget;
}

namespace Inkscape {
namespace Extension {

class Extension;


/** A class to represent a notebookparameter of an extension. */
class ParamNotebook : public Parameter {
private:
    /**
     * Internal value.  This should point to a string that has
     * been allocated in memory.  And should be free'd.
     * It is the name of the current page.
     */
    gchar * _value;

    /**
     * A class to represent the pages of a notebookparameter of an extension.
     */
    class ParamNotebookPage : public Parameter {
    private:
        std::vector<Parameter *> parameters; /**< A table to store the parameters for this page.
                              This only gets created if there are parameters on this
                              page */

    public:
        static ParamNotebookPage * makepage (Inkscape::XML::Node * in_repr, Inkscape::Extension::Extension * in_ext);

        ParamNotebookPage(const gchar * name,
                      const gchar * text,
                      const gchar * description,
                      bool hidden,
                      Inkscape::Extension::Extension * ext,
                      Inkscape::XML::Node * xml);
        ~ParamNotebookPage() override;

        Gtk::Widget * get_widget(SPDocument * doc, Inkscape::XML::Node * node, sigc::signal<void> * changeSignal) override;
        void paramString (std::list <std::string> &list);
        gchar * get_text () {return _text;};
        Parameter * get_param (const gchar * name) override;
    }; /* class ParamNotebookPage */


    std::vector<ParamNotebookPage*> pages; /**< A table to store the pages with parameters for this notebook.
                              This only gets created if there are pages in this
                              notebook */
public:
    ParamNotebook(const gchar * name,
                  const gchar * text,
                  const gchar * description,
                  bool hidden,
                  int indent,
                  Inkscape::Extension::Extension * ext,
                  Inkscape::XML::Node * xml);
    ~ParamNotebook() override;

    Gtk::Widget * get_widget(SPDocument * doc, Inkscape::XML::Node * node, sigc::signal<void> * changeSignal) override;

    /**
     * A function to get the currentpage and the parameters in a string form.
     * @return A string with the 'value' and all the parameters on all pages as command line arguments.
     */
    void string (std::list <std::string> &list) const override;

    // Explicitly call superclass version to avoid method being hidden.
    void string(std::string &string) const override {return Parameter::string(string);}


    Parameter * get_param (const gchar * name) override;

    const gchar * get (const SPDocument * /*doc*/, const Inkscape::XML::Node * /*node*/) { return _value; }
    const gchar * set (const int in, SPDocument * doc, Inkscape::XML::Node * node);
}; /* class ParamNotebook */





}  // namespace Extension
}  // namespace Inkscape

#endif /* INK_EXTENSION_PARAMNOTEBOOK_H_SEEN */

/*
  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 :