--- Attributes.html 2005/07/19 04:54:22 1.6 +++ Attributes.html 2005/10/22 17:43:49 1.7 @@ -271,13 +271,30 @@

key_info

-

Access a reference to an array of [single, explanation]

+

Access a hash of key information. The data that are returned are:

+ + + + + + +
hash key namewhat is itdata type
singleWhether the attribute can handle only a single data point[boolean]
descriptionExplanation of key[free text]
readonlywhether to allow read/write[boolean]
is_cvattribute is a cv term[boolean]
+

Single is a boolean, if it is true only the last value returned should be used. Note that the other methods willl still return all the values, it is upto the implementer to ensure that only the last value is used.

-

Explanation is a user-derived explanation that can be defined.

-

if a reference to an array is provided, along with the key, those values will be set.

-

e.g. -$fig->key_info($key, \@data); # set the data -$data=$fig->key_info($key); # get the data

+ +

Explanation is a user-derived explanation that can be free text

+ +

If a reference to a hash is provided, along with the key, those values will be set to the attribute_keys file

+ +

Returns an empty hash if the key is not provieded or doesn't exist

+ +

e.g.
+$fig->key_info($key, \%data); # set the data
+$data=$fig->key_info($key); # get the data
+

+ + +

get_key_value