Rhino C++ API
8.21
|
#include <RhinoSdkUiOptionsListCtrlItem.h>
Friends | |
class | CGroupComboItem |
CRhinoUiOptionsListCtrlGroupComboBox
Description: This control will display a simple combo box containing a list of options.
CRhinoUiOptionsListCtrlGroupComboBox::CRhinoUiOptionsListCtrlGroupComboBox | ( | LPCTSTR | lpsLabel = NULL , |
LPCTSTR | lpsText = NULL , |
||
int | iIndentLevel = 0 , |
||
CRhinoUiComboBoxItemData::class_type | ct = CRhinoUiComboBoxItemData::ct_strings |
||
) |
Description: Constructor
Parameters: lpsLabel [in] Label for this item, appears in left column of options list lpsText [in] Text associated with this item, appears in right column of options list ct [in] Type of control this is
See Also: CRhinoUiOptionsListCtrlItem::CRhinoUiOptionsListCtrlItem() CRhinoUiOptionsListCtrlItem::CRhinoUiOptionsListCtrlComboBox()
|
virtual |
Description: Destructor
int CRhinoUiOptionsListCtrlGroupComboBox::AddGroupItem | ( | const wchar_t * | lpsComboText, |
CRhinoUiOptionsListCtrlItem ** | group_items, | ||
const int | count | ||
) |
Description: Call this method to add an item and identify items associated with this group
Parameters: lpsComboText [in] String to display in the comobo box group_items [in] List of options list control items associated with this combo box item count [in] Number of items in group_items
Returns: Returns zero based combo box index for new item or -1 on error
int CRhinoUiOptionsListCtrlGroupComboBox::AddGroupItem | ( | const wchar_t * | lpsComboText, |
ON_SimpleArray< CRhinoUiOptionsListCtrlItem * > & | group_items | ||
) |
Description: Call this method to add an item and identify items associated with this group
Parameters: lpsComboText [in] String to display in the comobo box group_items [in] List of options list control items associated with this combo box item
Returns: Returns zero based combo box index for new item or -1 on error
int CRhinoUiOptionsListCtrlGroupComboBox::CurGroupSel | ( | ) | const |
Description: Call this method to get the current combo box selection.
Returns: Returns zero based index of current selection
See Also: CRhinoUiOptionsListCtrl::SetCurGroupSel()
|
virtual |
Description: This method is called after PopulateComboBox() to set default value or modify the contents of the combo box.
The default implementation of this method sends a CRhinoUiOptionsListCtrl::m_custom_win_msg_id custom windows message with a CRhinoUiOptionsListCtrl::nc_on_populate_combo_box notification code to the parent of the options list control this item is inserted in. You can either override this method prior to adding a item to the options list control or respond the the nc_populate_combo_box in the window that owns the options list control. See CRhinoUiOptionsListCtrl::notification_codes for details.
Returns: Returns true if combo box should be displayed; otherwise false.
See Also: CRhinoUiOptionsListCtrlComboBox::BeginEditItem() CRhinoUiOptionsListCtrl::m_custom_win_msg_id CRhinoUiOptionsListCtrl::notification_codes
Reimplemented from CRhinoUiOptionsListCtrlComboBox.
|
virtual |
Description: This method is called when the current selection of the combo box has changed.
The default implementation of this method sends a CRhinoUiOptionsListCtrl::m_custom_win_msg_id custom windows message with a CRhinoUiOptionsListCtrl::nc_on_combo_box_sel_changed notification code to the parent of the options list control this item is inserted in. You can either override this method prior to adding a item to the options list control or respond the the nc_populate_combo_box in the window that owns the options list control. See CRhinoUiOptionsListCtrl::notification_codes for details.
See Also: CRhinoUiOptionsListCtrl::m_custom_win_msg_id CRhinoUiOptionsListCtrl::notification_codes
Reimplemented from CRhinoUiOptionsListCtrlComboBox.
|
virtual |
Description: This method is called by the control when the combo box has been created and needs to be populated with data. If this method returns false the combo box will destroyed.
The default implementation of this method sends a CRhinoUiOptionsListCtrl::m_custom_win_msg_id custom windows message with a CRhinoUiOptionsListCtrl::nc_populate_combo_box notification code to the parent of the options list control this item is inserted in. You can either override this method prior to adding a item to the options list control or respond the the nc_populate_combo_box in the window that owns the options list control. See CRhinoUiOptionsListCtrl::notification_codes for details.
Returns: Returns true if the combo box has been initialized and populated and should be displayed.
See Also: CRhinoUiOptionsListCtrlComboBox::BeginEditItem() CRhinoUiOptionsListCtrl::m_custom_win_msg_id CRhinoUiOptionsListCtrl::notification_codes
Reimplemented from CRhinoUiOptionsListCtrlComboBox.
int CRhinoUiOptionsListCtrlGroupComboBox::SetCurGroupSel | ( | int | iCur | ) |
Description: Call this method to set the current combo box selection. Setting the current selection will show all items associated with that selection and hide all items associated with the previous selection
Parameters: iCur [in] Zero based index of item to make current.
Returns: Returns previous current item or -1 if there was none
See Also: CRhinoUiOptionsListCtrl::CurGroupSel()
|
friend |
|
protected |
|
protected |