Code

Added notebook (tabs) support for Effects. Now you can specify a notebook parameter...
[inkscape.git] / src / extension / api.cpp
1 namespace Inkscape {
2 namespace Extension {
3 namespace API {
5 doc    file_open (gchar * uri, Inkscape::Extension::Input * ext) { }
6 bool   file_save (SPDocument * doc, gchar * uri, Inkscape::Extension::Output * ext) { }
7 bool   print_doc (SPDOcument * doc) { }
9 array  getElements(string element_name) { }
10 string getElementName() { }
11 string getElementByID(string id) { }
12 string getElementID() { }
13 hash   getAttributes() { }
14 string getAttribute(string attribute) { }
15 bool   SetAttribute(string name, string value) { }
16 bool   SetAttributes(hash) { }
17 bool   hasChildren() { }
18 array  getChildren() { }
19 obj    getFirstChild() { }
20 obj    getLastChild() { }
21 array  getSiblings() { }
22 obj    getNextSibling() { }
23 obj    getPrevSibling() { }
24 int    getChildIndex() { }
25 obj    getChildAtIndex(int index) { }
26 obj    getParent() { }
27 array  getParents() { }
28 bool   isAncestor(obj) { }
29 bool   isDescendant(obj) { }
30 cdata  getCDATA() { }
32 /** looks up the numerical ID of the given verb name.  (E.g., it could
33     pull it out of the SPVerbActionDef props[] static object) */
34 int    verb_find(string verb_name) { }
36 /** retrieves the Action object for the verb in the given view */
37 action verb_get_action(int verb, int view) { }
39 /** retrieves the view, given the action object */
40 view   action_get_view(int action) { }
42 /** invokes the Action for the verb.  It validates the parameters and
43     calls the appropriate listener that will handle the action. */
44 void   action_perform(int action, int data, int pdata) { }
46 void   action_set_active(int action, int state, int data) { }
48 void   action_set_sensitive(int action, int state, int data) { }
50 void    prefs_set_int_attribute(string path, string attr, int value) { }
52 int     prefs_get_int_attribute(string path, string attr, gint def) { }
54 int     prefs_get_int_attribute_limited(string path, string attr, int def, int min, int max) { }
56 void    prefs_set_double_attribute(string path, string attr, double value) { }
58 double  prefs_get_double_attribute(string path, string attr, double def) { }
60 double  prefs_get_double_attribute_limited(string path, string attr, double def, double min, double max) { }
62 string  prefs_get_string_attribute(string path, string attr) { }
64 void    prefs_set_string_attribute(string path, string attr, string value) { }
66 void    prefs_set_recent_file(string uri, string name) { }
68 string[] prefs_get_recent_files() { }
70 /** returns a pointer to an instance of the desired stock object in
71     the current doc, importing the object if necessary. */
72 obj get_stock_item(string urn) { }
74 /** adds a new stock SVG def to the Inkscape Application.  All
75     currently loaded and new documents will have access to the item. */
76 void set_stock_item_from_svg(void) { }
78 /** This function gets the variable by the name 'name' with the data
79     in 'data'.  It can be a boolean, integer or a string. */
80 get_param (gchar * name, bool data) { }
81 get_param (gchar * name, int data) { }
82 get_param (gchar * name, gchar * data) { }
84 /** This function sets the variable by the name 'name' with the data
85     in 'data'.  It can be a boolean, integer or a string.  In the
86     case of the string it is copied. */
87 set_param (gchar * name, bool data) { }
88 set_param (gchar * name, int data) { }
89 set_param (gchar * name, gchar * data) { }
92 } } } /* namespaces Inkscape::Extension::API */