Logo Search packages:      
Sourcecode: inkscape version File versions  Download package

Inkscape::Extension::Parameter Class Reference

#include <parameter.h>

Inheritance diagram for Inkscape::Extension::Parameter:

Inkscape::Extension::ParamBool Inkscape::Extension::ParamDescription

List of all members.


Detailed Description

A class to represent the parameter of an extension.

This is really a super class that allows them to abstract all the different types of parameters into some that can be passed around. There is also a few functions that are used by all the different parameters.

Definition at line 42 of file parameter.h.


Public Member Functions

bool get_bool (const SPDocument *doc, const Inkscape::XML::Node *node)
 Wrapper to cast to the object and use it's function.
guint32 get_color (const SPDocument *doc, const Inkscape::XML::Node *node)
const gchar * get_enum (const SPDocument *doc, const Inkscape::XML::Node *node)
 Wrapper to cast to the object and use it's function.
float get_float (const SPDocument *doc, const Inkscape::XML::Node *node)
 Wrapper to cast to the object and use it's function.
int get_int (const SPDocument *doc, const Inkscape::XML::Node *node)
 Wrapper to cast to the object and use it's function.
const gchar * get_string (const SPDocument *doc, const Inkscape::XML::Node *node)
 Wrapper to cast to the object and use it's function.
gchar const * get_tooltip (void)
virtual Gtk::Widget * get_widget (SPDocument *doc, Inkscape::XML::Node *node, sigc::signal< void > *changeSignal)
 Basically, if there is no widget pass a NULL.
const gchar * name (void)
 Parameter (const gchar *name, const gchar *guitext, Inkscape::Extension::Extension *ext)
 Parameter (const gchar *name, const gchar *guitext, const gchar *desc, const Parameter::_scope_t scope, Inkscape::Extension::Extension *ext)
 Oop, now that we need a parameter, we need it's name.
bool set_bool (bool in, SPDocument *doc, Inkscape::XML::Node *node)
 Wrapper to cast to the object and use it's function.
guint32 set_color (guint32 in, SPDocument *doc, Inkscape::XML::Node *node)
 Wrapper to cast to the object and use it's function.
float set_float (float in, SPDocument *doc, Inkscape::XML::Node *node)
 Wrapper to cast to the object and use it's function.
int set_int (int in, SPDocument *doc, Inkscape::XML::Node *node)
 Wrapper to cast to the object and use it's function.
const gchar * set_string (const gchar *in, SPDocument *doc, Inkscape::XML::Node *node)
 Wrapper to cast to the object and use it's function.
virtual void string (std::string &string)
 If I'm not sure which it is, just don't return a value.
virtual void string (std::list< std::string > &list)
virtual ~Parameter (void)
 Just free the allocated name.

Static Public Member Functions

static Parametermake (Inkscape::XML::Node *in_repr, Inkscape::Extension::Extension *in_ext)
 This function creates a parameter that can be used later. This is typically done in the creation of the extension and defined in the XML file describing the extension (it's private so people have to use the system) :).

Protected Types

enum  _scope_t { SCOPE_USER, SCOPE_DOCUMENT, SCOPE_NODE }
 List of possible scopes. More...

Protected Member Functions

Inkscape::XML::Nodedocument_param_node (SPDocument *doc)
Inkscape::XML::Nodefind_child (Inkscape::XML::Node *adult)
Inkscape::XML::Nodenew_child (Inkscape::XML::Node *parent)
gchar * pref_name (void)
 Build the name to write the parameter from the extension's ID and the name of this parameter.

Protected Attributes

gchar * _desc
 Description of the parameter.
_scope_t _scope
 Scope of the parameter.
gchar * _text
 Text for the GUI selection of this.

Private Attributes

gchar * _name
 The name of this parameter.
Inkscape::Extension::Extensionextension
 Which extension is this parameter attached to?

The documentation for this class was generated from the following files:

Generated by  Doxygen 1.6.0   Back to index