From 2633767789e4264b13ef91a684accf734fb4e94f Mon Sep 17 00:00:00 2001 From: "Jon A. Cruz" Date: Wed, 26 Oct 2011 21:55:51 -0700 Subject: Fixing more broken and split doc comments. (bzr r10697) --- src/ui/widget/text.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'src/ui/widget/text.h') 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 signal_activate(); bool setProgrammatically; // true if the value was set by setValue, not changed by the user; -- cgit v1.2.3