gtkmm: Atk::Value Class Reference

# Atk::Value Class Reference

The ATK interface implemented by valuators and components which display or select a value from a bounded range of values. More...

Inherits Glib::Interface.

Inherited by Atk::NoOpObject.

Collaboration diagram for Atk::Value:
[legend]

List of all members.

## Public Member Functions
virtual | ~Value ()
AtkValue* | gobj ()
| Provides access to the underlying C GObject.
const AtkValue* | gobj () const
| Provides access to the underlying C GObject.
void | get_current_value (Glib::ValueBase&value) const
| Gets the value of this object.
void | get_maximum_value (Glib::ValueBase&value) const
| Gets the maximum value of this object.
void | get_minimum_value (Glib::ValueBase&value) const
| Gets the minimum value of this object.
bool | set_current_value (const Glib::ValueBase&value)
| Sets the value of this object.
## Static Public Member Functions
static void | add_interface (GType gtype_implementer)
## Protected Member Functions
virtual void | get_current_value_vfunc (Glib::ValueBase&value) const
virtual void | get_maximum_value_vfunc (Glib::ValueBase&value) const
virtual void | get_minimum_value_vfunc (Glib::ValueBase&value) const
virtual bool | set_current_value_vfunc (const Glib::ValueBase&value)
## Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Atk::Value > | wrap (AtkValue* object, bool take_copy=false)
| A Glib::wrap() method for this object.

## Detailed Description

The ATK interface implemented by valuators and components which display or select a value from a bounded range of values.

This should be implemented for components which either display a value from a bounded range, or which allow the user to specify a value from a bounded range, or both. For instance, most sliders and range controls, as well as dials, should have Atk::Object representations which implement Atk::Value on the component's behalf. Atk::Values may be read-only, in which case attempts to alter the value return false to indicate failure.

## Constructor & Destructor Documentation

virtual Atk::Value::~Value | ( |  | ) | `[virtual]`

## Member Function Documentation

static void Atk::Value::add_interface | ( | GType | gtype_implementer | ) | `[static]`

void Atk::Value::get_current_value | ( | Glib::ValueBase & | value | ) | const

Gets the value of this object.

Parameters:

  | value | A Value representing the current accessible value.

virtual void Atk::Value::get_current_value_vfunc | ( | Glib::ValueBase & | value | ) | const`[protected, virtual]`

void Atk::Value::get_maximum_value | ( | Glib::ValueBase & | value | ) | const

Gets the maximum value of this object.

Parameters:

  | value | A Value representing the maximum accessible value.

virtual void Atk::Value::get_maximum_value_vfunc | ( | Glib::ValueBase & | value | ) | const`[protected, virtual]`

void Atk::Value::get_minimum_value | ( | Glib::ValueBase & | value | ) | const

Gets the minimum value of this object.

Parameters:

  | value | A Value representing the minimum accessible value.

virtual void Atk::Value::get_minimum_value_vfunc | ( | Glib::ValueBase & | value | ) | const`[protected, virtual]`

const AtkValue* Atk::Value::gobj | ( |  | ) | const`[inline]`

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Atk::NoOpObject.

AtkValue* Atk::Value::gobj | ( |  | ) | `[inline]`

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Atk::NoOpObject.

bool Atk::Value::set_current_value | ( | const Glib::ValueBase & | value | ) |

Sets the value of this object.

Parameters:

  | value | A Value which is the desired new accessible value.

Returns:
  `true` if new value is successfully set, `false` otherwise.

virtual bool Atk::Value::set_current_value_vfunc | ( | const Glib::ValueBase & | value | ) | `[protected, virtual]`

## Friends And Related Function Documentation

Glib::RefPtr< Atk::Value > wrap | ( | AtkValue * | object,
|  | bool | take_copy = `false` |
| ) |  |  | `[related]`

A Glib::wrap() method for this object.

Parameters:

  | object | The C instance.
  | take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns:
  A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file:

- atkmm/value.h