Logo Search packages:      
Sourcecode: inkscape version File versions

Inkscape::Extension::Effect Class Reference

#include <effect.h>

Inheritance diagram for Inkscape::Extension::Effect:

Inkscape::Extension::Extension

List of all members.


Detailed Description

Effects are extensions that take a document and do something to it in place. This class adds the extra functions required to make extensions effects.

Definition at line 39 of file effect.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.
void effect (Inkscape::UI::View::View *doc)
 The function that 'does' the effect itself.
 Effect (Inkscape::XML::Node *in_repr, Implementation::Implementation *in_imp)
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.
Inkscape::Verbget_verb (void)
 Accessor function for a pointer to the verb.
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 place_menu (Inkscape::XML::Node *menus)
bool prefs (Inkscape::UI::View::View *doc)
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_pref_dialog (PrefDialog *prefdialog)
void set_state (state_t in_state)
 A function to set whether the extension should be loaded or unloaded.

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 Effectget_last_effect (void)
 Static function to get the last effect used.
static void place_menus (void)
static void set_last_effect (Effect *in_effect)
 Sets which effect was called last.

Public Attributes

bool no_doc
bool no_live_preview

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

Inkscape::XML::Nodefind_menu (Inkscape::XML::Node *menustruct, const gchar *name)
void merge_menu (Inkscape::XML::Node *base, Inkscape::XML::Node *start, Inkscape::XML::Node *patern, Inkscape::XML::Node *mergee)

Static Private Member Functions

static gchar * remove_ (gchar *instr)

Private Attributes

Glib::ustring _id_noprefs
 ID used for the verb without preferences.
Inkscape::XML::Node_menu_node
 Menu node created for this effect.
Glib::ustring _name_noprefs
 Name used for the verb without preferences.
PrefDialog_prefDialog
 The preference dialog if it is shown.
EffectVerb _verb
 The verb representing this effect.
EffectVerb _verb_nopref
 The verb representing this effect. Without preferences.
bool _workingDialog
 Whehter a working dialog should be shown.

Static Private Attributes

static Inkscape::XML::Node_effects_list = NULL
 The location of the Extensions and Filters menus on the menu structure XML file. This is saved so it only has to be discovered once.
static Inkscape::XML::Node_filters_list = NULL
static Effect_last_effect = NULL
 This is the last effect that was used. This is used in a menu item to rapidly recall the same effect.

Classes

class  EffectVerb
 This is the verb type that is used for all effect's verbs. It provides convience functions and maintains a pointer back to the effect that created it. More...

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

Generated by  Doxygen 1.6.0   Back to index