Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Atk::Value Class Reference

An AtkValue C++ wrapper class. More...

#include <xfc/atk/value.hh>

Inheritance diagram for Xfc::Atk::Value:

Xfc::G::TypeInterface Xfc::G::TypeInstance Xfc::Trackable List of all members.

Public Member Functions

Accessors
Methods

Detailed Description

An AtkValue C++ wrapper class.

Value 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 Value on the component's behalf. Values may be read-only, in which case attempts to alter the value return false to indicate failure.


Member Function Documentation

void Xfc::Atk::Value::get_current_value ( G::Value value  )  const

Gets the value of this object.

Parameters:
value A G::Value representing the current accessible value.

void Xfc::Atk::Value::get_maximum_value ( G::Value value  )  const

Gets the maximum value for this object.

Parameters:
value A G::Value representing the maximum accessible value.

void Xfc::Atk::Value::get_minimum_value ( G::Value value  )  const

Gets the minimum value for this object.

Parameters:
value A G::Value representing the minimum accessible value.

bool Xfc::Atk::Value::set_current_value ( const G::Value value  ) 

Sets the value of this object.

Parameters:
value A G::Value which is the desired new accessible value.
Returns:
true if the new value is successfully set, false otherwise.


The documentation for this class was generated from the following file: Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC 4.3