worked on path parsing.

[inkscape.git] / src / extension / param / parameter.h

diff --git a/src/extension/param/parameter.h b/src/extension/param/parameter.h
index ca3a2a0d4603210745bfcf4b73eae1a51d715211..54249c12eb3373a48fb28c6e10469088c5920556 100644 (file)
--- a/src/extension/param/parameter.h
+++ b/src/extension/param/parameter.h
@@ -1,12 +1,7 @@
-#ifndef __INK_EXTENSION_PARAM_H__
-#define __INK_EXTENSION_PARAM_H__
-
-/** \file
- * Parameters for extensions.
+/** @file
+ * @brief Parameters for extensions.
  */
-
-/*
- * Authors:
+/* Authors:
  *   Ted Gould <ted@gould.cx>
  *
  * Copyright (C) 2005-2006 Authors
@@ -14,24 +9,29 @@
  * Released under GNU GPL, read the file 'COPYING' for more information
  */
 
-/** \brief  The root directory in the preferences database for extension-related parameters. */
-#define PREF_DIR "extensions"
+#ifndef SEEN_INK_EXTENSION_PARAM_H__
+#define SEEN_INK_EXTENSION_PARAM_H__
 
 #include <gtkmm/widget.h>
+#include <glibmm/i18n.h>
 
 #include "xml/document.h"
 #include "xml/node.h"
 #include "document.h"
-#include <extension/extension-forward.h>
-#include "prefs-utils.h"
-
-#include <glibmm/i18n.h>
-
+#include "extension/extension-forward.h"
 #include <color.h>
 
 namespace Inkscape {
 namespace Extension {
 
+/**
+ * @brief The root directory in the preferences database for extension-related parameters
+ *
+ * The directory path has both a leading and a trailing slash, so that extension_pref_root + pref_name works
+ * without having to append a separator.
+ */
+extern Glib::ustring const extension_pref_root;
+
 /** \brief  A class to represent the parameter of an extension
 
     This is really a super class that allows them to abstract all
@@ -61,8 +61,8 @@ protected:
     gchar *  _text;
     /** \brief  Whether the GUI is visible */
     bool _gui_hidden;
-       /** \brief  A tip for the GUI if there is one */
-       gchar *  _gui_tip;
+    /** \brief  A tip for the GUI if there is one */
+    gchar *  _gui_tip;
 
 
     /* **** funcs **** */
@@ -77,7 +77,7 @@ public:
                               const gchar * desc,
                               const Parameter::_scope_t scope,
                               bool gui_hidden,
-                                                         const gchar * gui_tip,
+                              const gchar * gui_tip,
                               Inkscape::Extension::Extension * ext);
                   Parameter  (const gchar * name,
                               const gchar * guitext,
@@ -108,8 +108,12 @@ public:
 
     static Parameter * make (Inkscape::XML::Node * in_repr, Inkscape::Extension::Extension * in_ext);
     virtual Gtk::Widget * get_widget (SPDocument * doc, Inkscape::XML::Node * node, sigc::signal<void> * changeSignal);
+
     gchar const * get_tooltip (void) { return _desc; }
 
+    /** \brief  Indicates if the GUI for this parameter is hidden or not */
+    bool         get_gui_hidden ()   { return _gui_hidden; }
+
     virtual void string (std::list <std::string> &list);
     virtual void string (std::string &string);
 };
@@ -128,4 +132,4 @@ public:
   fill-column:99
   End:
 */
-// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :
+// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :