scalar.h revision ea3e4fdbdbf0a48ae887b096d301549da77d5707
/*
* Authors:
* Carl Hetherington <inkscape@carlh.net>
* Derek P. Moore <derekm@hackunix.org>
* Bryce Harrington <bryce@bryceharrington.org>
*
* Copyright (C) 2004 Carl Hetherington
*
* Released under GNU GPL. Read the file 'COPYING' for more information.
*/
#ifndef INKSCAPE_UI_WIDGET_SCALAR_H
#define INKSCAPE_UI_WIDGET_SCALAR_H
#include "labelled.h"
namespace Inkscape {
namespace UI {
namespace Widget {
/**
* A labelled text box, with spin buttons and optional
* icon or suffix, for entering arbitrary number values.
*/
class Scalar : public Labelled
{
public:
/**
* Construct a Scalar 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).
*/
Scalar(Glib::ustring const &label,
Glib::ustring const &tooltip,
Glib::ustring const &suffix = "",
Glib::ustring const &icon = "",
bool mnemonic = true);
/**
* Construct a Scalar 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).
*/
Scalar(Glib::ustring const &label,
Glib::ustring const &tooltip,
unsigned digits,
Glib::ustring const &suffix = "",
Glib::ustring const &icon = "",
bool mnemonic = true);
/**
* Construct a Scalar 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).
*/
Scalar(Glib::ustring const &label,
Glib::ustring const &tooltip,
Gtk::Adjustment &adjust,
unsigned digits = 0,
Glib::ustring const &suffix = "",
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 getValue() const;
/**
* Get the value spin_button represented as an integer.
*/
int getValueAsInt() 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.
* @todo Remove the second parameter - deprecated
*/
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(double value);
/**
* Manually forces an update of the spin button.
*/
void update();
/**
* Adds a slider (HScale) to the left of the spinbox.
*/
void addSlider();
/**
* Signal raised when the spin button's value changes.
*/
Glib::SignalProxy0<void> signal_value_changed();
/**
* 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;
};
} // namespace Widget
} // namespace UI
} // namespace Inkscape
#endif // INKSCAPE_UI_WIDGET_SCALAR_H
/*
Local Variables:
mode:c++
c-file-style:"stroustrup"
c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
indent-tabs-mode:nil
fill-column:99
End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :