FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kInfoBool Struct Reference

Description

Represents constraint and validity information for a boolean setting.

Inheritance diagram for kInfoBool:
Inheritance graph

Public Member Functions

kStatus kInfoBool_Init (kInfoBool *info, kBool min, kBool max)
 Initializes a kInfoBool structure to default values. More...
 
kStatus kInfoBool_Validate (kInfoBool *info, kBool value)
 Validates an input value against min/max values. More...
 

Public Attributes

kBool absoluteMax
 Maximum valid value under any circumstances.
 
kBool absoluteMin
 Minimum valid value under any circumstances.
 
kBool isGrouped
 Value is constrained to be the same as its peers within a group.
 
kBool isReadOnly
 Value is read-only (cannot be modified).
 
kBool relativeMax
 Maximum valid value, limited by current values of other (more dominant) settings.
 
kBool relativeMin
 Minimum valid value, limited by current values of other (more dominant) settings.
 
kViolation violations
 Constraints violated by the current value.
 

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