Gocator Development Kit
 All Classes Files Functions Variables Typedefs Friends Modules Pages
GdkParamInfo Class Reference

Description

Represents the schema of a configurable parameter.

Inheritance diagram for GdkParamInfo:
Inheritance graph

Public Member Functions

kStatus GdkParamInfo_AddOptionInt (GdkParamInfo info, k32s option, const kChar *name)
 Add an option for an integer parameter. More...
 
kStatus GdkParamInfo_ClearOptions (GdkParamInfo info)
 Clears all options for the parameter. More...
 
kBool GdkParamInfo_IsOptional (GdkParamInfo info)
 Returns whether or not the parameter is optional. More...
 
const kCharGdkParamInfo_Label (GdkParamInfo info)
 Returns the display label of the parameter. More...
 
k64f GdkParamInfo_MaxFloat (GdkParamInfo info)
 Returns the maximum value for a decimal parameter. More...
 
k32s GdkParamInfo_MaxInt (GdkParamInfo info)
 Returns the maximum value for an integer parameter. More...
 
k64f GdkParamInfo_MinFloat (GdkParamInfo info)
 Returns the minimum value for a decimal parameter. More...
 
k32s GdkParamInfo_MinInt (GdkParamInfo info)
 Returns the minimum value for an integer parameter. More...
 
const kCharGdkParamInfo_Name (GdkParamInfo info)
 Returns the name of the parameter. More...
 
k32s GdkParamInfo_OptionAtInt (GdkParamInfo info, kSize index)
 Returns the option at a specified index for an integer parameter. More...
 
kSize GdkParamInfo_OptionCount (GdkParamInfo info)
 Returns the number of options for the parameter. More...
 
const kCharGdkParamInfo_OptionNameAt (GdkParamInfo info, kSize index)
 Returns the option name at a specified index. More...
 
kStatus GdkParamInfo_RemoveOption (GdkParamInfo info, kSize index)
 Remove the option at a specified index. More...
 
kStatus GdkParamInfo_SetIsOptional (GdkParamInfo info, kBool optional)
 Sets a parameter to be optional or not. More...
 
kStatus GdkParamInfo_SetLabel (GdkParamInfo info, const kChar *label)
 Sets the display label of the parameter. More...
 
kStatus GdkParamInfo_SetMaxFloat (GdkParamInfo info, k64f max)
 Sets the maximum value for a decimal parameter. More...
 
kStatus GdkParamInfo_SetMaxInt (GdkParamInfo info, k32s max)
 Sets the maximum value for an integer parameter. More...
 
kStatus GdkParamInfo_SetMinFloat (GdkParamInfo info, k64f min)
 Sets the minimum value for a decimal parameter. More...
 
kStatus GdkParamInfo_SetMinInt (GdkParamInfo info, k32s min)
 Sets the minimum value for an integer parameter. More...
 
kStatus GdkParamInfo_SetName (GdkParamInfo info, const kChar *name)
 Sets the name of the parameter. More...
 
kStatus GdkParamInfo_SetUnits (GdkParamInfo info, const kChar *units)
 Sets the units of the parameter. More...
 
GdkParamType GdkParamInfo_Type (GdkParamInfo info)
 Returns the parameter type. More...
 
const kCharGdkParamInfo_Units (GdkParamInfo info)
 Returns the units of the parameter. More...
 

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