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

Inkscape::Extension::Extension Class Reference

#include <extension.h>

Inheritance diagram for Inkscape::Extension::Extension:

Inkscape::Extension::Effect

List of all members.


Detailed Description

The object that is the basis for the Extension system. This object contains all of the information that all Extension have. The individual items are detailed within. This is the interface that those who want to _use_ the extensions system should use. This is most likely to be those who are inside the Inkscape program.

Definition at line 78 of file extension.h.


Public Types

enum  state_t { STATE_LOADED, STATE_UNLOADED, STATE_DEACTIVATED }

Public Member Functions

Gtk::Widget * autogui (SPDocument *doc, Inkscape::XML::Node *node, sigc::signal< void > *changeSignal=NULL)
 A function to automatically generate a GUI using the parameters.
virtual bool check (void)
 A function to check the validity of the extension.
void deactivate (void)
 This function diactivates the extension (which makes it unusable, but not deleted).
bool deactivated (void)
 Find out the status of the extension.
 Extension (Inkscape::XML::Node *in_repr, Implementation::Implementation *in_imp)
 Constructs an Extension from a Inkscape::XML::Node.
gchar const * get_help (void)
 Gets the help string for this extension.
Gtk::VBox * get_help_widget (void)
gchar * get_id (void)
 Get the ID of this extension - not a copy don't delete!
Implementation::Implementationget_imp (void)
Gtk::VBox * get_info_widget (void)
gchar * get_name (void)
 Get the name of this extension - not a copy don't delete!
bool get_param_bool (const gchar *name, const SPDocument *doc=NULL, const Inkscape::XML::Node *node=NULL)
 Gets a parameter identified by name with the bool placed in value.
guint32 get_param_color (const gchar *name, const SPDocument *doc=NULL, const Inkscape::XML::Node *node=NULL)
 Gets a parameter identified by name with the float placed in value.
const gchar * get_param_enum (const gchar *name, const SPDocument *doc=NULL, const Inkscape::XML::Node *node=NULL)
float get_param_float (const gchar *name, const SPDocument *doc=NULL, const Inkscape::XML::Node *node=NULL)
 Gets a parameter identified by name with the float placed in value.
int get_param_int (const gchar *name, const SPDocument *doc=NULL, const Inkscape::XML::Node *node=NULL)
 Gets a parameter identified by name with the integer placed in value.
const gchar * get_param_string (const gchar *name, const SPDocument *doc=NULL, const Inkscape::XML::Node *node=NULL)
 Gets a parameter identified by name with the string placed in value. It isn't duplicated into the value string.
Gtk::VBox * get_params_widget (void)
Inkscape::XML::Nodeget_repr (void)
 A getter for the internal Repr, does not add a reference.
state_t get_state (void)
 A getter for the state variable.
bool loaded (void)
 A quick function to test the state of the extension.
unsigned int param_count ()
 A function to get the the number of parameters that the extension has.
unsigned int param_visible_count ()
 A function to get the the number of parameters that are visible to the user that the extension has.
void paramListString (std::list< std::string > &retlist)
 A function to get the parameters in a string form.
void printFailure (Glib::ustring reason)
 A quick function to print out a standard start of extension errors in the log.
bool set_param_bool (const gchar *name, bool value, SPDocument *doc=NULL, Inkscape::XML::Node *node=NULL)
 Sets a parameter identified by name with the boolean in the parameter value.
guint32 set_param_color (const gchar *name, guint32 color, SPDocument *doc=NULL, Inkscape::XML::Node *node=NULL)
 Sets a parameter identified by name with the string in the parameter value.
float set_param_float (const gchar *name, float value, SPDocument *doc=NULL, Inkscape::XML::Node *node=NULL)
 Sets a parameter identified by name with the integer in the parameter value.
int set_param_int (const gchar *name, int value, SPDocument *doc=NULL, Inkscape::XML::Node *node=NULL)
 Sets a parameter identified by name with the integer in the parameter value.
const gchar * set_param_string (const gchar *name, const gchar *value, SPDocument *doc=NULL, Inkscape::XML::Node *node=NULL)
 Sets a parameter identified by name with the string in the parameter value.
void set_state (state_t in_state)
 A function to set whether the extension should be loaded or unloaded.
virtual ~Extension (void)
 Destroys the Extension.

Static Public Member Functions

static void error_file_close (void)
 A function to close the error log file.
static void error_file_open (void)
 A function to open the error log file.

Static Public Attributes

static std::vector< const gchar * > search_path

Static Protected Member Functions

static void add_val (Glib::ustring labelstr, Glib::ustring valuestr, Gtk::Table *table, int *row)

Protected Attributes

Implementation::Implementationimp
Inkscape::XML::Noderepr
ExpirationTimer * timer

Private Member Functions

void make_param (Inkscape::XML::Node *paramrepr)

Private Attributes

std::vector< Dependency * > _deps
gchar * _help
state_t _state
gchar * id
gchar * name
GSList * parameters

Static Private Attributes

static std::ofstream error_file

Classes

class  no_overwrite
class  param_not_bool_param
class  param_not_color_param
class  param_not_enum_param
class  param_not_exist
class  param_not_float_param
class  param_not_int_param
class  param_not_string_param
class  param_wrong_type

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

Generated by  Doxygen 1.6.0   Back to index