All Frameworks Class Hierarchy This Framework Previous Next Indexes
Dialog Class CATDlgCombo
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATEventSubscriber
|
+---System.CATCommand
|
+---Dialog.CATDialog
|
+---Dialog.CATDlgControl
|
+---CATDlgCombo
Usage: you must use this class as is. You should never derive it.
public class CATDlgCombo
Base class for combo boxes.
Role:
The combo allows the end user to choose a value or an option by selecting a character string from a predefined list,
or through a keyboard entry.
Use a combo whenever you propose to the end user to select an alphanumerical value from a discrete list,
or enter an alphanumerical value to update a discrete list.
Constructor and Destructor Index
- o
CATDlgCombo(CATDialog*,CATString&,CATDlgStyle)
- Constructs a CATDlgCombo.
- o
~CATDlgCombo()
-
Method Index
- o
ClearField()
- Clears the keyboard entry field.
- o
ClearLine()
- Deletes all the lines.
- o
ClearLine(int)
- Deletes the line specified by the index passed in argument (first line has 0 for index).
- o
ClearLine(int*,int)
- Deletes the lines specified by the array of index passed in argument (first line has 0 for index).
- o
ClearSelect()
- Clears the selection and reinitializes the selected line number.
- o
GetComboCloseUpNotification()
- Returns the event notification sent whenever the list of values is hidden
- o
GetComboDropNotification()
- Returns the event notification sent whenever the list of values is displayed.
- o
GetComboModifyNotification()
- Returns the event notification sent whenever the keyboard entry is modified by selection.
- o
GetComboSelectNotification()
- Returns the event notification sent whenever a value is selected in the list.
- o
GetDropDownTextWidth()
- Returns the number of characters in dropdown window.
- o
GetEditModifyNotification()
- Returns the event notification sent whenever the keyboard entry is modified by editing.
- o
GetField()
- Returns the keyboard entry field for a double combo.
- o
GetField(CATUnicodeString&)
- Retrieves the keyboard entry field.
- o
GetLine(CATUnicodeString&,CATString&,int)
- Retrieves the contents of the line from its index (first line has 0 for index).
- o
GetLine(CATUnicodeString&,char*,int&,int&,int)
- Retrieves the contents of the line from its index (first line has 0 for index).
- o
GetLine(CATUnicodeString&,int)
- Retrieves the contents of the line from its index (first line has 0 for index).
- o
GetLine(CATUnicodeString&,unsigned char&,unsigned char&,unsigned char&,int)
- Retrieves the contents of the line from its index (first line has 0 for index).
- o
GetLine(CATUnicodeString&,unsigned short&,unsigned short&,unsigned short&,int)
- Retrieves the contents of the line from its index (first line has 0 for index).
- o
GetLine(int)
- Returns the contents of the line from its index, for CATDlgCmbDouble style only (first line has 0 for index).
- o
GetLineCount()
- Returns the number of lines of the combo box.
- o
GetSelect()
- Returns the selected line number.
- o
GetVisibleTextHeight()
- Returns the number of visible lines of the combo box.
- o
GetVisibleTextWidth()
- Returns the number of visible characters in the entry zone.
- o
SetDropDownTextWidth(int)
- Sets the number of columns in dropdown window.
- o
SetField(CATUnicodeString&)
- Sets the keyboard entry field with a string.
- o
SetField(double)
- Sets the keyboard entry field for a double combo.
- o
SetLine(CATUnicodeString&,CATString&,int,CATULong)
- Adds or modifies one line containing an icon and optionally a string.
- o
SetLine(CATUnicodeString&,char*,int,int,int,CATULong)
- Adds or modifies one line containing a monochrome icon and a string.
- o
SetLine(CATUnicodeString&,int,CATULong)
- Adds or modifies one line containing a string.
- o
SetLine(CATUnicodeString&,unsigned char,unsigned char,unsigned char,int,CATULong)
- Adds or modifies one line containing a colored rectangle and a string.
- o
SetLine(CATUnicodeString&,unsigned short,unsigned short,unsigned short,int,CATULong)
- Adds or modifies one line containing a drawn line and a string.
- o
SetLine(CATUnicodeString*,int,int,CATULong)
- Adds or modifies several lines containing strings.
- o
SetLine(double*,int,int,CATULong)
- Adds or modifies several lines containing doubles.
- o
SetLine(double,int,CATULong)
- Adds or modifies one line containing a double.
- o
SetSelect(CATUnicodeString&,int)
- Selects a line from its contents.
- o
SetSelect(double,int)
- Selects a line from its double contents.
- o
SetSelect(int,int)
- Selects a line from its index (first line has 0 for index).
- o
SetVisibleTextHeight(int)
- Sets the number of visible lines of the combo box.
- o
SetVisibleTextWidth(int)
- Sets the number of visible characters in the entry zone.
Constructor and Destructor
o CATDlgCombo
-
Constructs a CATDlgCombo.
- Parameters:
-
- iParent
- The parent of the combo box.
- iObjectName
- The name of the combo box.
- iStyle
- The style of the combo box.
The style can be :
- default
- if no value is passed, for the standard combo,
composed of an entry zone which displays the selected value, and a list permanently displayed.
- CATDlgCmbDropDown
- for the drop down combo, composed of an entry zone which displays
the selected value, and the list of values to select in, displayed when the arrow located on the right
of the entry zone is selected.
- CATDlgCmbOptionStyle
- for the option style combo. On UNIX, it is very close to the
drop down combo, with a Motif style. On Windows, this style is equivalent to CATDlgCmbDropDown combo.
- CATDlgCmbEntry
- to allow keyboard text entry in addition to text selection
for drop down and standard combos.
- CATDlgCmbDouble
- if the entered number must be a double precision floating number.
- CATDlgCmbColor
- to show a color palette. Available in conjunction with CATDlgCmbDropDown only.
- CATDlgCmbLineType
- to show a linetype palette. Available in conjunction with CATDlgCmbDropDown only.
- CATDlgCmbBitmap
- to show an icon palette. Available in conjunction with CATDlgCmbDropDown only.
o ~CATDlgCombo
public virtual ~CATDlgCombo( | ) |
-
Methods
o ClearField
-
Clears the keyboard entry field.
o ClearLine
-
Deletes all the lines.
o ClearLine
public void ClearLine( | int | iIndex) |
-
Deletes the line specified by the index passed in argument (first line has 0 for index).
- Parameters:
-
- iIndex
- The index of the line to delete.
o ClearLine
public void ClearLine( | int* | iLinesToClear, |
| int | iNumberOfLinesToClear) |
-
Deletes the lines specified by the array of index passed in argument (first line has 0 for index).
- Parameters:
-
- iLinesToClear
- The array of index of the lines to delete.
- iNumberOfLinesToClear
- The number of lines to delete.
o ClearSelect
public void ClearSelect( | ) |
-
Clears the selection and reinitializes the selected line number.
o GetComboCloseUpNotification
-
Returns the event notification sent whenever the list of values is hidden
o GetComboDropNotification
-
Returns the event notification sent whenever the list of values is displayed.
o GetComboModifyNotification
-
Returns the event notification sent whenever the keyboard entry is modified by selection.
o GetComboSelectNotification
-
Returns the event notification sent whenever a value is selected in the list.
o GetDropDownTextWidth
public int GetDropDownTextWidth( | ) |
-
Returns the number of characters in dropdown window.
o GetEditModifyNotification
-
Returns the event notification sent whenever the keyboard entry is modified by editing.
o GetField
-
Returns the keyboard entry field for a double combo.
o GetField
-
Retrieves the keyboard entry field.
- Parameters:
-
- oEntry
- The returned entry field.
o GetLine
-
Retrieves the contents of the line from its index (first line has 0 for index).
- Parameters:
-
- oVal
- The returned contents of the specified line.
- oIcon
- The returned name of the icon.
- iIndex
- The index of the line.
o GetLine
public void GetLine( | CATUnicodeString& | oVal, |
| char* | oBitmap, |
| int& | oWidth, |
| int& | oHeight, |
| int | iIndex) |
-
Retrieves the contents of the line from its index (first line has 0 for index).
- Parameters:
-
- oVal
- The returned contents of the specified line.
- oBitmap
- The returned bitmap representing the icon.
- oWidth
- The returned width of the icon.
- oHeight
- The returned height of the icon.
- iIndex
- The index of the line.
o GetLine
-
Retrieves the contents of the line from its index (first line has 0 for index).
- Parameters:
-
- oLine
- The returned contents of the specified line.
- iIndex
- The index of the line.
o GetLine
public void GetLine( | CATUnicodeString& | oVal, |
| unsigned char& | oRed, |
| unsigned char& | oGreen, |
| unsigned char& | oBlue, |
| int | iIndex) |
-
Retrieves the contents of the line from its index (first line has 0 for index).
- Parameters:
-
- oVal
- The returned contents of the specified line.
- oRed,oGreen,oBlue
- The returned RGB composants of the color of the specified line.
- iIndex
- The index of the line.
o GetLine
public void GetLine( | CATUnicodeString& | oVal, |
| unsigned short& | oMask, |
| unsigned short& | oRepet, |
| unsigned short& | oWeight, |
| int | iIndex) |
-
Retrieves the contents of the line from its index (first line has 0 for index).
- Parameters:
-
- oVal
- The returned contents of the specified line.
- oMask
- The returned mask.
- oRepet
- The returned number of pixels for each bit of the mask.
- oWeight
- The returned height of the line (in pixels).
- iIndex
- The index of the line.
o GetLine
public double GetLine( | int | iIndex) |
-
Returns the contents of the line from its index, for CATDlgCmbDouble style only (first line has 0 for index).
- Parameters:
-
- iIndex
- The index of the line.
o GetLineCount
public int GetLineCount( | ) |
-
Returns the number of lines of the combo box.
o GetSelect
-
Returns the selected line number.
o GetVisibleTextHeight
public int GetVisibleTextHeight( | ) |
-
Returns the number of visible lines of the combo box.
o GetVisibleTextWidth
public int GetVisibleTextWidth( | ) |
-
Returns the number of visible characters in the entry zone.
o SetDropDownTextWidth
public void SetDropDownTextWidth( | int | iColumns) |
-
Sets the number of columns in dropdown window.
- Parameters:
-
- iColumns
- The number of columns to set.
o SetField
-
Sets the keyboard entry field with a string.
- Parameters:
-
- iEntry
- The entry field to set.
o SetField
public void SetField( | double | iEntry) |
-
Sets the keyboard entry field for a double combo.
- Parameters:
-
- iEntry
- The entry field to set.
o SetLine
-
Adds or modifies one line containing an icon and optionally a string.
- Parameters:
-
- iVal
- The contents of the line to add or modify.
- iIcon
- The name of the icon.
- iIndex
- The index to specify where to add the new line or which line to modify.
If no value is passed, new lines are added at the end of the list.
- iModeAddOrModify
- The mode to specify whether you add a new line (CATDlgDataAdd set by default) or
you modify an existing line (CATDlgDataModify).
- Returns:
- the index of the first added or modified line in the list.
o SetLine
public int SetLine( | const CATUnicodeString& | iVal, |
| const char* | iBitmap, |
| int | iWidth, |
| int | iHeight, |
| int | iIndex | =-1, |
| CATULong | iModeAddOrModify | =CATDlgDataAdd ) |
-
Adds or modifies one line containing a monochrome icon and a string.
- Parameters:
-
- iVal
- The contents of the line to add or modify.
- iBitmap
- The monochrome bitmap representing the icon.
The length expected is (iWidth+7)/8 * iHeight
- iWidth
- The width of the icon.
- iHeight
- The height of the icon.
- iIndex
- The index to specify where to add the new line or which line to modify.
If no value is passed, new lines are added at the end of the list.
- iModeAddOrModify
- The mode to specify whether you add a new line (CATDlgDataAdd set by default) or
you modify an existing line (CATDlgDataModify).
- Returns:
- the index of the first added or modified line in the list.
o SetLine
public int SetLine( | const CATUnicodeString& | iLine, |
| int | iIndex | =-1, |
| CATULong | iModeAddOrModify | =CATDlgDataAdd ) |
-
Adds or modifies one line containing a string.
- Parameters:
-
- iLine
- The contents of the line to add or modify.
- iIndex
- The index to specify where to add the new line or which line to modify.
If no value is passed, new lines are added at the end of the list.
- iModeAddOrModify
- The mode to specify whether you add a new line (CATDlgDataAdd set by default) or
you modify an existing line (CATDlgDataModify).
- Returns:
- the index of the first added or modified line in the list.
o SetLine
public int SetLine( | const CATUnicodeString& | iVal, |
| unsigned char | iRed, |
| unsigned char | iGreen, |
| unsigned char | iBlue, |
| int | iIndex | =-1, |
| CATULong | iModeAddOrModify | =CATDlgDataAdd ) |
-
Adds or modifies one line containing a colored rectangle and a string.
- Parameters:
-
- iVal
- The contents of the line to add or modify.
- iRed,iGreen,iBlue
- The RGB composants of the color of the specified line.
- iIndex
- The index to specify where to add the new line or which line to modify.
If no value is passed, new lines are added at the end of the list.
- iModeAddOrModify
- The mode to specify whether you add a new line (CATDlgDataAdd set by default) or
you modify an existing line (CATDlgDataModify).
- Returns:
- the index of the first added or modified line in the list.
o SetLine
public int SetLine( | const CATUnicodeString& | iVal, |
| unsigned short | iMask, |
| unsigned short | iRepet, |
| unsigned short | iWeight, |
| int | iIndex | =-1, |
| CATULong | iModeAddOrModify | =CATDlgDataAdd ) |
-
Adds or modifies one line containing a drawn line and a string.
- Parameters:
-
- iVal
- The contents of the line to add or modify.
- iMask
- The mask.
- iRepet
- The number of pixels for each bit of the mask.
- iWeight
- The height of the line (in pixels).
- iIndex
- The index to specify where to add the new line or which line to modify.
If no value is passed, new lines are added at the end of the list.
- iModeAddOrModify
- The mode to specify whether you add a new line (CATDlgDataAdd set by default) or
you modify an existing line (CATDlgDataModify).
- Returns:
- the index of the first added or modified line in the list.
o SetLine
public int SetLine( | const CATUnicodeString* | iLinesArray, |
| int | iNbLines, |
| int | iIndex | =-1, |
| CATULong | iModeAddOrModify | =CATDlgDataAdd ) |
-
Adds or modifies several lines containing strings.
- Parameters:
-
- iLinesArray
- The contents of the lines to add.
- iNbLines
- The number of lines to add.
- iIndex
- The index to specify where to add the new lines or which line to modify.
If no value is passed, new lines are added at the end of the list.
- iModeAddOrModify
- The mode to specify whether you add a new line (CATDlgDataAdd set by default) or
you modify an existing line (CATDlgDataModify).
- Returns:
- the index of the first added or modified line in the list.
o SetLine
public int SetLine( | const double* | iValArray, |
| int | iNbLines, |
| int | iIndex | =-1, |
| CATULong | iModeAddOrModify | =CATDlgDataAdd ) |
-
Adds or modifies several lines containing doubles.
- Parameters:
-
- iValArray
- The contents of the lines to add (for CATDlgCmbDouble style only).
- iNbLines
- The number of lines to add.
- iIndex
- The index to specify where to add the new lines or which line to modify.
If no value is passed, new lines are added at the end of the list.
- iModeAddOrModify
- The mode to specify whether you add a new line (CATDlgDataAdd set by default) or
you modify an existing line (CATDlgDataModify).
- Returns:
- the index of the first added or modified line in the list.
o SetLine
public int SetLine( | double | iVal, |
| int | iIndex | =-1, |
| CATULong | iModeAddOrModify | =CATDlgDataAdd ) |
-
Adds or modifies one line containing a double.
- Parameters:
-
- iVal
- The contents of the line to add or modify (for CATDlgCmbDouble style only).
- iIndex
- The index to specify where to add the new line or which line to modify.
If no value is passed, new lines are added at the end of the list.
- iModeAddOrModify
- The mode to specify whether you add a new line (CATDlgDataAdd set by default) or
you modify an existing line (CATDlgDataModify).
- Returns:
- the index of the first added or modified line in the list.
o SetSelect
-
Selects a line from its contents.
- Parameters:
-
- iString
- Contents of the line to select.
- iNotify
- Set this parameter to a non null value if you want the corresponding notification to be sent.
Otherwise set it to 0, so no notification will be sent.
- Returns:
- the index of the selected line.
o SetSelect
public int SetSelect( | double | iVal, |
| int | iNotify | =1) |
-
Selects a line from its double contents.
- Parameters:
-
- iVal
- Contents of the line to select (for CATDlgCmbDouble style only).
- iNotify
- Set this parameter to a non null value if you want the corresponding notification to be sent.
Otherwise set it to 0, so no notification will be sent.
- Returns:
- the index of the selected line.
o SetSelect
public int SetSelect( | int | iIndex, |
| int | iNotify | =1) |
-
Selects a line from its index (first line has 0 for index).
- Parameters:
-
- iIndex
- The index of the line to select.
- iNotify
- Set this parameter to a non null value if you want the corresponding notification to be sent.
Otherwise set it to 0, so no notification will be sent.
- Returns:
- the index of the selected line.
o SetVisibleTextHeight
public void SetVisibleTextHeight( | int | iRows) |
-
Sets the number of visible lines of the combo box.
- Parameters:
-
- iRows
- The number of visible lines to set for the combo box.
o SetVisibleTextWidth
public void SetVisibleTextWidth( | int | iColumns) |
-
Sets the number of visible characters in the entry zone.
- Parameters:
-
- iColumns
- The number of visible character to set for the entry zone.
This object is included in the file: CATDlgCombo.h
If needed, your Imakefile.mk should include the module: DI0PANV2