summaryrefslogtreecommitdiff
path: root/docs/tmpl/atkvalue.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/tmpl/atkvalue.sgml')
-rw-r--r--docs/tmpl/atkvalue.sgml12
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/tmpl/atkvalue.sgml b/docs/tmpl/atkvalue.sgml
index 0dc4e18..8f244b2 100644
--- a/docs/tmpl/atkvalue.sgml
+++ b/docs/tmpl/atkvalue.sgml
@@ -2,11 +2,17 @@
AtkValue
<!-- ##### SECTION Short_Description ##### -->
-
-
+ATK Interface implemented by valuators and components which display or
+select a value from a bounded range of values.
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+#AtkValue 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 #AtkObject representations which
+implement #AtkValue on the component's behalf. #AtKValues may be
+read-only, in which case attempts to alter the value return FALSE to
+indicate failure.
</para>
<!-- ##### SECTION See_Also ##### -->