![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index 97d71c5ee2ffba31a6e21d71d38cf5d1df5263a5..e67a4b95f65c84acfa2d864272dcba50cc2648c0 100644 (file)
#include "db.h"
#include "dependency.h"
#include "timer.h"
-#include "parameter.h"
+#include "param/parameter.h"
namespace Inkscape {
namespace Extension {
std::vector<const gchar *> Extension::search_path;
std::ofstream Extension::error_file;
-Parameter * param_shared (const gchar * name, GSList * list);
+Parameter * get_param (const gchar * name);
/**
\return none
not related to the module directly. If the Repr does not include
a name and an ID the module will be left in an errored state.
*/
-Extension::Extension (Inkscape::XML::Node * in_repr, Implementation::Implementation * in_imp) : _help(NULL)
+Extension::Extension (Inkscape::XML::Node * in_repr, Implementation::Implementation * in_imp)
+ : _help(NULL)
+ , _gui(true)
{
repr = in_repr;
Inkscape::GC::anchor(in_repr);
/* TODO: Handle what happens if we don't have these two */
while (child_repr != NULL) {
char const * chname = child_repr->name();
+ if (!strncmp(chname, INKSCAPE_EXTENSION_NS_NC, strlen(INKSCAPE_EXTENSION_NS_NC))) {
+ chname += strlen(INKSCAPE_EXTENSION_NS);
+ }
if (chname[0] == '_') /* Allow _ for translation of tags */
chname++;
if (!strcmp(chname, "id")) {
delete timer;
timer = NULL;
/** \todo Need to do parameters here */
-
+
+ // delete parameters:
+ for (GSList * list = parameters; list != NULL; list = g_slist_next(list)) {
+ Parameter * param = reinterpret_cast<Parameter *>(list->data);
+ delete param;
+ }
+ g_slist_free(parameters);
+
+
for (unsigned int i = 0 ; i < _deps.size(); i++) {
delete _deps[i];
}
void
Extension::printFailure (Glib::ustring reason)
{
- error_file << _("Extension \"") << name << _("\" failed to load because ");
- error_file << reason.raw();
- error_file << std::endl;
- return;
+ error_file << _("Extension \"") << name << _("\" failed to load because ");
+ error_file << reason.raw();
+ error_file << std::endl;
+ return;
}
/**
\brief This function looks through the linked list for a parameter
structure with the name of the passed in name
\param name The name to search for
- \param list The list to look for
This is an inline function that is used by all the get_param and
set_param functions to find a param_t in the linked list with
- the passed in name. It is done as an inline so that it will be
- optimized into a 'jump' by the compiler.
+ the passed in name.
This function can throw a 'param_not_exist' exception if the
name is not found.
The first thing that this function checks is if the list is NULL.
It could be NULL because there are no parameters for this extension
- or because all of them have been checked (I'll spoil the ending and
- tell you that this function is called recursively). If the list
+ or because all of them have been checked. If the list
is NULL then the 'param_not_exist' exception is thrown.
-
- Otherwise, the function looks at the current param_t that the element
- list points to. If the name of that param_t matches the passed in
- name then that param_t is returned. Otherwise, this function is
- called again with g_slist_next as a parameter.
*/
Parameter *
-param_shared (const gchar * name, GSList * list)
+Extension::get_param (const gchar * name)
{
- Parameter * output;
-
if (name == NULL) {
throw Extension::param_not_exist();
}
- if (list == NULL) {
+ if (this->parameters == NULL) {
+ // the list of parameters is empty
throw Extension::param_not_exist();
}
- output = static_cast<Parameter *>(list->data);
- if (!strcmp(output->name(), name)) {
- return output;
+ for (GSList * list = this->parameters; list != NULL; list =
+g_slist_next(list)) {
+ Parameter * param = static_cast<Parameter*>(list->data);
+ if (!strcmp(param->name(), name)) {
+ return param;
+ } else {
+ Parameter * subparam = param->get_param(name);
+ if (subparam) {
+ return subparam;
+ }
+ }
}
- return param_shared(name, g_slist_next(list));
+ // if execution reaches here, no parameter matching 'name' was found
+ throw Extension::param_not_exist();
}
/**
Extension::get_param_string (const gchar * name, const SPDocument * doc, const Inkscape::XML::Node * node)
{
Parameter * param;
-
- param = param_shared(name, parameters);
+ param = get_param(name);
return param->get_string(doc, node);
}
+const gchar *
+Extension::get_param_enum (const gchar * name, const SPDocument * doc, const Inkscape::XML::Node * node)
+{
+ Parameter* param = get_param(name);
+ return param->get_enum(doc, node);
+}
+
+gchar const *
+Extension::get_param_optiongroup( gchar const * name, SPDocument const * doc, Inkscape::XML::Node const * node)
+{
+ Parameter* param = get_param(name);
+ return param->get_optiongroup(doc, node);
+}
+
+
/**
\return The value of the parameter identified by the name
\brief Gets a parameter identified by name with the bool placed
Extension::get_param_bool (const gchar * name, const SPDocument * doc, const Inkscape::XML::Node * node)
{
Parameter * param;
-
- param = param_shared(name, parameters);
+ param = get_param(name);
return param->get_bool(doc, node);
}
Extension::get_param_int (const gchar * name, const SPDocument * doc, const Inkscape::XML::Node * node)
{
Parameter * param;
-
- param = param_shared(name, parameters);
+ param = get_param(name);
return param->get_int(doc, node);
}
Extension::get_param_float (const gchar * name, const SPDocument * doc, const Inkscape::XML::Node * node)
{
Parameter * param;
- param = param_shared(name, parameters);
+ param = get_param(name);
return param->get_float(doc, node);
}
+/**
+ \return The string value for the parameter specified
+ \brief Gets a parameter identified by name with the float placed
+ in value.
+ \param name The name of the parameter to get
+ \param doc The document to look in for document specific parameters
+ \param node The node to look in for a specific parameter
+
+ Look up in the parameters list, then execute the function on that
+ found parameter.
+*/
+guint32
+Extension::get_param_color (const gchar * name, const SPDocument * doc, const Inkscape::XML::Node * node)
+{
+ Parameter* param = get_param(name);
+ return param->get_color(doc, node);
+}
+
/**
\return The passed in value
\brief Sets a parameter identified by name with the boolean
Extension::set_param_bool (const gchar * name, bool value, SPDocument * doc, Inkscape::XML::Node * node)
{
Parameter * param;
- param = param_shared(name, parameters);
+ param = get_param(name);
return param->set_bool(value, doc, node);
}
Extension::set_param_int (const gchar * name, int value, SPDocument * doc, Inkscape::XML::Node * node)
{
Parameter * param;
- param = param_shared(name, parameters);
+ param = get_param(name);
return param->set_int(value, doc, node);
}
Extension::set_param_float (const gchar * name, float value, SPDocument * doc, Inkscape::XML::Node * node)
{
Parameter * param;
- param = param_shared(name, parameters);
+ param = get_param(name);
return param->set_float(value, doc, node);
}
Extension::set_param_string (const gchar * name, const gchar * value, SPDocument * doc, Inkscape::XML::Node * node)
{
Parameter * param;
- param = param_shared(name, parameters);
+ param = get_param(name);
return param->set_string(value, doc, node);
}
+gchar const *
+Extension::set_param_optiongroup(gchar const * name, gchar const * value, SPDocument * doc, Inkscape::XML::Node * node)
+{
+ Parameter * param = get_param(name);
+ return param->set_optiongroup(value, doc, node);
+}
+
+
+/**
+ \return The passed in value
+ \brief Sets a parameter identified by name with the string
+ in the parameter value.
+ \param name The name of the parameter to set
+ \param value The value to set the parameter to
+ \param doc The document to look in for document specific parameters
+ \param node The node to look in for a specific parameter
+
+ Look up in the parameters list, then execute the function on that
+ found parameter.
+*/
+guint32
+Extension::set_param_color (const gchar * name, guint32 color, SPDocument * doc, Inkscape::XML::Node * node)
+{
+ Parameter* param = get_param(name);
+ return param->set_color(color, doc, node);
+}
+
/** \brief A function to open the error log file. */
void
Extension::error_file_open (void)
*/
void addWidget (Gtk::Widget * widg, gchar const * tooltip) {
if (widg == NULL) return;
- this->pack_start(*widg, true, true, 2);
+ this->pack_start(*widg, false, false, 2);
if (tooltip != NULL) {
- _tooltips.set_tip(*widg, Glib::ustring(tooltip));
- // printf("Setting tooltip: %s\n", tooltip);
+ _tooltips.set_tip(*widg, Glib::ustring(_(tooltip)));
}
return;
};
function to get each widget. Then, each of those is placed into
a Gtk::VBox, which is then returned to the calling function.
- If there are no parameters, this function just returns NULL.
+ If there are no visible parameters, this function just returns NULL.
+ If all parameters are gui_visible = false NULL is returned as well.
*/
Gtk::Widget *
-Extension::autogui (SPDocument * doc, Inkscape::XML::Node * node)
+Extension::autogui (SPDocument * doc, Inkscape::XML::Node * node, sigc::signal<void> * changeSignal)
{
- if (g_slist_length(parameters) == 0) return NULL;
+ if (!_gui || param_visible_count() == 0) return NULL;
AutoGUI * agui = Gtk::manage(new AutoGUI());
+ //go through the list of parameters to see if there are any non-hidden ones
for (GSList * list = parameters; list != NULL; list = g_slist_next(list)) {
Parameter * param = reinterpret_cast<Parameter *>(list->data);
- Gtk::Widget * widg = param->get_widget(doc, node);
+ if (param->get_gui_hidden()) continue; //Ignore hidden parameters
+ Gtk::Widget * widg = param->get_widget(doc, node, changeSignal);
gchar const * tip = param->get_tooltip();
agui->addWidget(widg, tip);
- }
-
+ }
+
agui->show();
return agui;
};
/**
\brief A function to get the parameters in a string form
- \return A string with all the parameters as command line arguements
-
- I don't really like this function, but it works for now.
+ \return An array with all the parameters in it.
- \todo Do this better.
*/
-Glib::ustring *
-Extension::paramString (void)
+void
+Extension::paramListString (std::list <std::string> &retlist)
{
- Glib::ustring * param_string = new Glib::ustring("");
-
for (GSList * list = parameters; list != NULL; list = g_slist_next(list)) {
Parameter * param = reinterpret_cast<Parameter *>(list->data);
-
- *param_string += " --";
- *param_string += param->name();
- *param_string += "=";
- Glib::ustring * paramstr = param->string();
- *param_string += *paramstr;
- delete paramstr;
+ param->string(retlist);
}
- return param_string;
+ return;
}
/* Extension editor dialog stuff */
Gtk::VBox * retval = Gtk::manage(new Gtk::VBox());
if (_help == NULL) {
- Gtk::Label * content = Gtk::manage(new Gtk::Label("Currently there is no help available for this Extension. Please look on the Inkscape website or ask on the mailing lists if you have questions regarding this extension."));
+ Gtk::Label * content = Gtk::manage(new Gtk::Label(_("Currently there is no help available for this Extension. Please look on the Inkscape website or ask on the mailing lists if you have questions regarding this extension.")));
retval->pack_start(*content, true, true, 5);
content->set_line_wrap(true);
content->show();
return retval;
}
+unsigned int Extension::param_visible_count ( )
+{
+ unsigned int _visible_count = 0;
+ for (GSList * list = parameters; list != NULL; list = g_slist_next(list)) {
+ Parameter * param = reinterpret_cast<Parameter *>(list->data);
+ if (!param->get_gui_hidden()) _visible_count++;
+ }
+ return _visible_count;
+}
+
} /* namespace Extension */
} /* namespace Inkscape */