class HT_Option_Definition

class HT_Option_Definition

A configuration option is a (name, value) pair. An object of this class specifies the name and type of the option as well as the count and scope of the values of the option.

This class is generally referenced by renderers.

See Also

HT_Option, HT_Option_Enum, HT_Option_Table

Methods

count

Number of members of the option value.

name

Name of the option.

scope

Scope of the option definition ¾ Local or Global.

type

Common type of the members of the option value. Constructor

HT_Option_Definition

Creates an HT_Option_Defintion object.

HT_Option_Definition::count

Purpose

Queries the number of elements of an option value associated with this option definition object. Synopsis

int count()

Details An option value can be an array of items of similar type. This parameter gives the size of the array.

HT_Option_Definition::HT_Option_Definition

Purpose

Creates an object of type HT_Option_Definition from a given parameter list. Synopsis

HT_Option_Definition (HT_String const & name, HT_Option_Enum::Type 
    type, int count, HT_Option_Enum::Scope scope )

Details Creates an option definition object with the provided name, type, value count, and scope (local, global) values.

Options of global scope are inherited by descendent renderers, objects of local scope are not.

HT_Option_Definition::name

Purpose

Gets the name of this option definition object. Synopsis

HT_String const & name( )

Details This names the option. An option value is a name-value pair. This is the name appearing in the name-value pair for option values conforming to this option definition object.

HT_Option_Definition::scope

Purpose

Gets the scope of this option definition object. Synopsis

HT_Option_Enum::Scope scope()

Details The return value has one of the enumerated values :{local, global}.

Options of global scope are inherited by descendent renderers, objects of local scope are not.

See Also HT_Option_Enum

HT_Option_Definition::type

Purpose

Query the common type of members of option values corresponding to this option definition object. Synopsis

HT_Option_Enum::Type type()

Details Every option value consists of one or more values of a common type. This method returns that common type. The return value is one of the enumerated values of option types. Namely these are one of the following: None, Boolean, Int, Long, Float, String, Palette, Contour_Set, Address, Aggregate. See Also HT_Option_Enum