CATIAApplicationFrame CATComboColor
Usage: you must use this class as is. You should never derive it.
public class CATComboColor
Class to create a combo to select a color.
Role:This class constructs a combo to select color among predefined color or custom color.
The editor's combo displays the selected color. At the creation of the combo you
can set a specific color otherwise the white color is displayed.
To select a new color,the drop down list proposes in this order:
- The current selected color
- The defined "custom" colors
- The first 16 "basic" colors
- To see more color
When you click "more color" a second dialog object appears: you see the 48
"basic" colors and the 16 boxes for the "custom" colors.
You can choose a color in selecting a box and in clicking "OK", or you can defined
(or redefined) a "custom" color thanks to a third dialog object.
When a color is selected, a CATDlgComboSelectNotification notification is sent,
and you can retrieves the color thanks to the
- See also:
- , ,
Constructor and Destructor Index
- o
CATComboColor(CATDialog*,CATString&,CATDlgStyle,unsigned,unsigned,unsigned,int,unsigned int,unsigned int)
- Constructs the combo to select a color.
- o
~CATComboColor()
-
Method Index
- o
GetSelectedColor(unsigned int*,unsigned int*,unsigned int*)
- Retrieves the selected color.
- o
SetSelectedColor(unsigned int,unsigned int,unsigned int)
- Sets the selected color.
Constructor and Destructor
o CATComboColor
| public CATComboColor( | | iParent, |
| const | iDialogObjectName, |
| | iStyle | = NULL, |
| const | iRed | = 255, |
| const | iGreen | = 255, |
| const | iBlue | = 255, |
| | iUsage | = 0, |
| | iAutoComboAvailable | = 0, |
| | iTypeOfColorTable | = 0) |
-
Constructs the combo to select a color.
- Parameters:
-
- iParent
- The dialog's parent.
- iDialogObjectName
- The name of the dialog object.
- iStyle
- Internal usage. Set NULL the legal value.
- iRed
- It's defined the red component of the first selected color.The value ranges from 0 to 255.
- iGreen
- It's defined the green component of the first selected color.The value ranges from 0 to 255.
- iBlue
- It's defined the blue component of the first selected color.The value ranges from 0 to 255.
- iUsage
- Internal usage, set 0 as the default value.
- iAutoComboAvailable
- Internal usage, set 0 as the default value.
- iTypeOfColorTable
- Internal usage, set 0 as the default value.
o ~CATComboColor
| public virtual ~CATComboColor( | ) |
-
Methods
o GetSelectedColor
| public GetSelectedColor( | | iRed, |
| | iGreen, |
| | iBlue) |
-
Retrieves the selected color.
Role: When a color is choosen , a
CATDlgComboSelectNotification notification is sent, and you
can retrieve the selected color using this method.
- Parameters:
-
- iRed
- It's defined the red component of the selected color.The value ranges from 0 to 255
- iGreen
- It's defined the green component of the selected color.The value ranges from 0 to 255
- iBlue
- It's defined the blue component of the selected color.The value ranges from 0 to 255
o SetSelectedColor
| public SetSelectedColor( | const | iRed, |
| const | iGreen, |
| const | iBlue) |
-
Sets the selected color.
This color appears in the editor and at the first place in the drop down list.
- Parameters:
-
- iRed
- It's defined the red component of the color.The value ranges from 0 to 255
- iGreen
- It's defined the green component of the color.The value ranges from 0 to 255
- iBlue
- It's defined the blue component of the color.The value ranges from 0 to 255
This object is included in the file: CATComboColor.h
If needed, your Imakefile.mk should include the module: CATIAApplicationFrame
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.