Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_UIFieldGetters.h File Reference


Namespaces

namespace  CP_UIFieldGetters

Functions

SInt16 CP_EditFieldToSInt16 (CP_EditField *inEditField)
SInt32 CP_EditFieldToSInt32 (CP_EditField *inEditField)
float CP_EditFieldToFloat (CP_EditField *inEditField)
CP_String CP_EditFieldToString (CP_EditField *inEditField)
SInt16 CP_EditFieldToSInt16 (CP_View *inSuperview, UInt32 inObjectID, bool inRecrusive=kCP_NoRecrusiveSearch)
SInt32 CP_EditFieldToSInt32 (CP_View *inSuperview, UInt32 inObjectID, bool inRecrusive=kCP_NoRecrusiveSearch)
UInt32 CP_EditFieldToUInt32 (CP_View *inSuperview, UInt32 inObjectID, bool inRecrusive=kCP_NoRecrusiveSearch)
float CP_EditFieldToFloat (CP_View *inSuperview, UInt32 inObjectID, bool inRecrusive=kCP_NoRecrusiveSearch)
CP_String CP_EditFieldToString (CP_View *inSuperview, UInt32 inObjectID, bool inRecrusive=kCP_NoRecrusiveSearch)
bool CP_PlatformControlToBool (CP_PlatformControl *inPlatformControl)
bool CP_PlatformControlToBool (CP_View *inSuperview, UInt32 inObjectID, bool inRecrusive=kCP_NoRecrusiveSearch)
SInt32 CP_PopupMenuToSInt32 (CP_PopupMenu *inPopupMenu)
SInt32 CP_PopupMenuToSInt32 (CP_View *inSuperview, UInt32 inObjectID, bool inRecrusive=kCP_NoRecrusiveSearch)
CP_RGBColor CP_SelectColorButtonToCP_RGBColor (CP_SelectColorButton *inSelectColorButton)
CP_RGBColor CP_SelectColorButtonToCP_RGBColor (CP_View *inSuperview, UInt32 inObjectID, bool inRecrusive=kCP_NoRecrusiveSearch)
CP_String CP_TextViewToString (CP_TextView *inTextView)
CP_String CP_TextViewToString (CP_View *inSuperview, UInt32 inObjectID, bool inRecrusive=kCP_NoRecrusiveSearch)

Function Documentation

SInt16 CP_UIFieldGetters::CP_EditFieldToSInt16 CP_EditField inEditField  ) 
 

Gets the text of a CP_EditField and returns as a SInt16.

Parameters:
inEditField The CP_EditField to return the value from.
Exceptions:
none 
Returns:
SInt16 The value of the edit field.

SInt32 CP_UIFieldGetters::CP_EditFieldToSInt32 CP_EditField inEditField  ) 
 

Gets the text of a CP_EditField and returns as a SInt32.

Parameters:
inEditField The CP_EditField to return the value from.
Exceptions:
none 
Returns:
SInt32 The value of the edit field.

float CP_UIFieldGetters::CP_EditFieldToFloat CP_EditField inEditField  ) 
 

Gets the text of a CP_EditField and returns as a float.

Parameters:
inEditField The CP_EditField to return the value from.
Exceptions:
none 
Returns:
float The value of the edit field.

CP_String CP_UIFieldGetters::CP_EditFieldToString CP_EditField inEditField  ) 
 

Gets the text of a CP_EditField and returns as a CP_String.

Parameters:
inEditField The CP_EditField to return the value from.
Exceptions:
none 
Returns:
CP_String The value of the edit field.

SInt16 CP_UIFieldGetters::CP_EditFieldToSInt16 CP_View inSuperview,
UInt32  inObjectID,
bool  inRecrusive
 

Gets the text of a CP_EditField and returns as a SInt16.

Parameters:
inSuperview The superview that contains the edit field.
inObjectID The view identifier of the edit field.
inRecrusive Flag to indicate if the search includes subviews of the superview.
Exceptions:
none 
Returns:
SInt16 The value of the edit field.

SInt32 CP_UIFieldGetters::CP_EditFieldToSInt32 CP_View inSuperview,
UInt32  inObjectID,
bool  inRecrusive
 

Gets the text of a CP_EditField and returns as a SInt32.

Parameters:
inSuperview The superview that contains the edit field.
inObjectID The view identifier of the edit field.
inRecrusive Flag to indicate if the search includes subviews of the superview.
Exceptions:
none 
Returns:
SInt32 The value of the edit field.

UInt32 CP_UIFieldGetters::CP_EditFieldToUInt32 CP_View inSuperview,
UInt32  inObjectID,
bool  inRecrusive
 

Gets the text of a CP_EditField and returns as a uInt32.

Parameters:
inSuperview The superview that contains the edit field.
inObjectID The view identifier of the edit field.
inRecrusive Flag to indicate if the search includes subviews of the superview.
Exceptions:
none 
Returns:
SInt32 The value of the edit field.

float CP_UIFieldGetters::CP_EditFieldToFloat CP_View inSuperview,
UInt32  inObjectID,
bool  inRecrusive
 

Gets the text of a CP_EditField and returns as a float.

Parameters:
inSuperview The superview that contains the edit field.
inObjectID The view identifier of the edit field.
inRecrusive Flag to indicate if the search includes subviews of the superview.
Exceptions:
none 
Returns:
float The value of the edit field.

CP_String CP_UIFieldGetters::CP_EditFieldToString CP_View inSuperview,
UInt32  inObjectID,
bool  inRecrusive
 

Gets the text of a CP_EditField and returns as a CP_String.

Parameters:
inSuperview The superview that contains the edit field.
inObjectID The view identifier of the edit field.
inRecrusive Flag to indicate if the search includes subviews of the superview.
Exceptions:
none 
Returns:
CP_String The value of the edit field.

bool CP_UIFieldGetters::CP_PlatformControlToBool CP_PlatformControl inPlatformControl  ) 
 

Returns true if the value of the platform control is greater than or equal to 1.

Parameters:
inPlatformControl The CP_PlatformControl to return the value from.
Exceptions:
none 
Returns:
bool True if the platform controls value is equal to or greater than 11.

bool CP_UIFieldGetters::CP_PlatformControlToBool CP_View inSuperview,
UInt32  inObjectID,
bool  inRecrusive
 

Returns true if the value of the platform control is greater than or equal to 1.

Parameters:
inSuperview The superview that contains the popup menu.
inObjectID The view identifier of the edit field.
inRecrusive Flag to indicate if the search includes subviews of the superview.
Exceptions:
none 
Returns:
bool True if the platform controls value is equal to or greater than 11.

SInt32 CP_UIFieldGetters::CP_PopupMenuToSInt32 CP_PopupMenu inPopupMenu  ) 
 

Gets the SInt32 value from a CP_PopupMenu.

Parameters:
inPopupMenu The CP_PopupMenu to return the value from.
Exceptions:
none 
Returns:
SInt32 The value of the popup menu.

SInt32 CP_UIFieldGetters::CP_PopupMenuToSInt32 CP_View inSuperview,
UInt32  inObjectID,
bool  inRecrusive
 

Gets the SInt32 value from a CP_PopupMenu.

Parameters:
inSuperview The superview that contains the popup menu.
inObjectID The view identifier of the edit field.
inRecrusive Flag to indicate if the search includes subviews of the superview.
Exceptions:
none 
Returns:
SInt32 The value of the popup menu.

CP_RGBColor CP_UIFieldGetters::CP_SelectColorButtonToCP_RGBColor CP_SelectColorButton inSelectColorButton  ) 
 

Gets the CP_RGBColor from a CP_SelectColorButton.

Parameters:
inSelectColorButton The CP_SelectColorButton to return the value from.
Exceptions:
none 
Returns:
CP_RGBColor The value of the select color button.

CP_RGBColor CP_UIFieldGetters::CP_SelectColorButtonToCP_RGBColor CP_View inSuperview,
UInt32  inObjectID,
bool  inRecrusive
 

Gets the color of a CP_SelectColorButton and returns as a CP_RGBColor.

Parameters:
inSuperview The superview that contains the edit field.
inObjectID The view identifier of the edit field.
inRecrusive Flag to indicate if the search includes subviews of the superview.
Exceptions:
none 
Returns:
CP_RGBColor The value of the select color button.

CP_String CP_UIFieldGetters::CP_TextViewToString CP_TextView inTextView  ) 
 

Gets the text of a CP_TextView and returns as a CP_String.

Parameters:
inTextview The CP_TextView to return the value from.
Exceptions:
none 
Returns:
CP_String The value of the text view.

CP_String CP_UIFieldGetters::CP_TextViewToString CP_View inSuperview,
UInt32  inObjectID,
bool  inRecrusive
 

Gets the text of a CP_TextView and returns as a CP_String.

Parameters:
inSuperview The superview that contains the edit field.
inObjectID The view identifier of the edit field.
inRecrusive Flag to indicate if the search includes subviews of the superview.
Exceptions:
none 
Returns:
CP_String The value of the text view.


Generated on Tue Sep 20 20:21:29 2005 for CPLAT_MacOS by  doxygen 1.4.0