diff options
Diffstat (limited to 'src/ui/widget/point.h')
| -rw-r--r-- | src/ui/widget/point.h | 113 |
1 files changed, 104 insertions, 9 deletions
diff --git a/src/ui/widget/point.h b/src/ui/widget/point.h index 68d2f4c9d..ced43c47a 100644 --- a/src/ui/widget/point.h +++ b/src/ui/widget/point.h @@ -1,7 +1,4 @@ -/** - * \brief Point Widget - A labelled text box, with spin buttons and optional - * icon or suffix, for entering arbitrary coordinate values. - * +/* * Authors: * Johan Engelen <j.b.c.engelen@utwente.nl> * Carl Hetherington <inkscape@carlh.net> @@ -13,7 +10,6 @@ * * Released under GNU GPL. Read the file 'COPYING' for more information. */ - #ifndef INKSCAPE_UI_WIDGET_POINT_H #define INKSCAPE_UI_WIDGET_POINT_H @@ -27,20 +23,61 @@ namespace Inkscape { namespace UI { namespace Widget { +/** + * A labelled text box, with spin buttons and optional icon or suffix, for + * entering arbitrary coordinate values. + */ class Point : public Labelled { public: + + + /** + * Construct a Point 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). + */ Point( Glib::ustring const &label, Glib::ustring const &tooltip, Glib::ustring const &suffix = "", Glib::ustring const &icon = "", bool mnemonic = true); + + /** + * Construct a Point Widget. + * + * @param label Label. + * @param digits Number of decimal digits to display. + * @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). + */ Point( Glib::ustring const &label, Glib::ustring const &tooltip, unsigned digits, Glib::ustring const &suffix = "", Glib::ustring const &icon = "", bool mnemonic = true); + + /** + * Construct a Point Widget. + * + * @param label Label. + * @param adjust Adjustment to use for the SpinButton. + * @param digits Number of decimal digits to display (defaults to 0). + * @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 true). + */ Point( Glib::ustring const &label, Glib::ustring const &tooltip, Gtk::Adjustment &adjust, @@ -49,35 +86,93 @@ public: Glib::ustring const &icon = "", bool mnemonic = true); + /** + * Fetches the precision of the spin buton. + */ unsigned getDigits() const; + + /** + * Gets the current step ingrement used by the spin button. + */ double getStep() const; + + /** + * Gets the current page increment used by the spin button. + */ double getPage() const; + + /** + * Gets the minimum range value allowed for the spin button. + */ double getRangeMin() const; + + /** + * Gets the maximum range value allowed for the spin button. + */ double getRangeMax() const; + bool getSnapToTicks() const; + + /** + * Get the value in the spin_button. + */ double getXValue() const; + double getYValue() const; + Geom::Point getValue() const; + + /** + * Get the value spin_button represented as an integer. + */ int getXValueAsInt() const; + int getYValueAsInt() const; + /** + * Sets the precision to be displayed by the spin button. + */ void setDigits(unsigned digits); + + /** + * Sets the step and page increments for the spin button. + */ void setIncrements(double step, double page); + + /** + * Sets the minimum and maximum range allowed for the spin button. + */ void setRange(double min, double max); + + /** + * Sets the value of the spin button. + */ void setValue(Geom::Point const & p); + /** + * Manually forces an update of the spin button. + */ void update(); + /** + * Signal raised when the spin button's value changes. + */ Glib::SignalProxy0<void> signal_x_value_changed(); + Glib::SignalProxy0<void> signal_y_value_changed(); - bool setProgrammatically(); // true if the value was set by setValue, not changed by the user; - // if a callback checks it, it must reset it back to false + /** + * Check 'setProgrammatically' of both scalar widgets. False if value is changed by user by clicking the widget. + * true if the value was set by setValue, not changed by the user; + * if a callback checks it, it must reset it back to false. + */ + bool setProgrammatically(); + void clearProgrammatically(); protected: - Scalar xwidget, ywidget; - + Scalar xwidget; + Scalar ywidget; }; } // namespace Widget |