summaryrefslogtreecommitdiffstats
path: root/src/ui/widget/text.h
diff options
context:
space:
mode:
authorJon A. Cruz <jon@joncruz.org>2011-10-27 04:55:51 +0000
committerJon A. Cruz <jon@joncruz.org>2011-10-27 04:55:51 +0000
commit2633767789e4264b13ef91a684accf734fb4e94f (patch)
tree0f6bc8d758b8e4bcf01d2dd393166907906c156e /src/ui/widget/text.h
parentCleanup pass on documentation that was dumping garbage into doxygen output. (diff)
downloadinkscape-2633767789e4264b13ef91a684accf734fb4e94f.tar.gz
inkscape-2633767789e4264b13ef91a684accf734fb4e94f.zip
Fixing more broken and split doc comments.
(bzr r10697)
Diffstat (limited to 'src/ui/widget/text.h')
-rw-r--r--src/ui/widget/text.h20
1 files changed, 20 insertions, 0 deletions
diff --git a/src/ui/widget/text.h b/src/ui/widget/text.h
index bccaefa2e..0f6efd01f 100644
--- a/src/ui/widget/text.h
+++ b/src/ui/widget/text.h
@@ -26,18 +26,38 @@ namespace Widget {
class Text : public Labelled
{
public:
+
+ /**
+ * Construct a Text Widget.
+ *
+ * @param label Label.
+ * @param suffix Suffix, placed after the widget (defaults to "").
+ * @param icon Icon filename, placed before the label (defaults to "").
+ * @param mnemonic Mnemonic toggle; if true, an underscore (_) in the label
+ * indicates the next character should be used for the
+ * mnemonic accelerator key (defaults to false).
+ */
Text(Glib::ustring const &label,
Glib::ustring const &tooltip,
Glib::ustring const &suffix = "",
Glib::ustring const &icon = "",
bool mnemonic = true);
+ /**
+ * Get the text in the entry.
+ */
const char* getText() const;
+ /**
+ * Sets the text of the text entry.
+ */
void setText(const char* text);
void update();
+ /**
+ * Signal raised when the spin button's value changes.
+ */
Glib::SignalProxy0<void> signal_activate();
bool setProgrammatically; // true if the value was set by setValue, not changed by the user;