Rhino C++ API
8.17
|
#include <RhinoSdkUiOptionsListCtrlItem.h>
CRhinoUiOptionsListCtrlLayerComboBox::CRhinoUiOptionsListCtrlLayerComboBox | ( | LPCTSTR | lpsLabel = NULL , |
LPCTSTR | lpsText = NULL , |
||
int | iIndentLevel = 0 |
||
) |
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
|
virtual |
Description: Destructor
|
virtual |
Description: CRhinoUiOptionsListCtrlComboBox virtual override
Call base class to reate CRhinoUiOptionsListCtrlComboBox combo box for layer and set default to current layer.
Parameters: See CRhinoUiOptionsListCtrlItem::BeginEditItem()
Returns: Returns true if combo box was created; otherwise false.
See Also: CRhinoUiOptionsListCtrlComboBox::BeginEditItem()
Reimplemented from CRhinoUiOptionsListCtrlColorComboBox.
bool CRhinoUiOptionsListCtrlLayerComboBox::IncludeDeletedLayers | ( | ) | const |
Description: This method is called by PopulateComboBox() when adding layers to the combo box.
Returns: Returns true if deleted layer names should be added to the combo box; otherwise false.
See Also: CRhinoUiOptionsListCtrlColorComboBox::PopulateComboBox() CRhinoUiOptionsListCtrlColorComboBox::SetIncludeDeletedLayers()
bool CRhinoUiOptionsListCtrlLayerComboBox::IncludeReferenceLayers | ( | ) | const |
Description: This method is called by PopulateComboBox() when adding layers to the combo box.
Returns: Returns true if reference layer names should be added to the combo box; otherwise false.
See Also: CRhinoUiOptionsListCtrlColorComboBox::PopulateComboBox() CRhinoUiOptionsListCtrlColorComboBox::SetIncludeReferenceLayers()
|
virtual |
Description: CRhinoUiOptionsListCtrlComboBox override, calls base class.
Overridden to save currently selected layer index.
See Also: CRhinoUiOptionsListCtrlComboBox::OnItemComboBoxSelChanged()
Reimplemented from CRhinoUiOptionsListCtrlColorComboBox.
|
virtual |
Description: CRhinoUiOptionsListCtrlComboBox virtual override
Overridden to fill combo box with current Rhino document layer list.
Returns: Returns true if combo box is filled with one or more layer name; otherwise false.
See Also: CRhinoUiOptionsListCtrlComboBox::PopulateComboBox() CRhinoUiOptionsListCtrlColorComboBox::SetIncludeByLayer() CRhinoUiOptionsListCtrlColorComboBox::IncludeByLayer()
Reimplemented from CRhinoUiOptionsListCtrlColorComboBox.
bool CRhinoUiOptionsListCtrlLayerComboBox::SetIncludeDeletedLayers | ( | bool | b | ) |
Description: Call this method to allow or disallow adding of deleted layers to the combo box.
Parameters: b [in] If truen then deleted layer names are added to combo box; otherwise they are not.
Returns: Returns the previous value.
See Also: CRhinoUiOptionsListCtrlColorComboBox::PopulateComboBox() CRhinoUiOptionsListCtrlColorComboBox::IncludeDeletedLayers()
bool CRhinoUiOptionsListCtrlLayerComboBox::SetIncludeReferenceLayers | ( | bool | b | ) |
Description: Call this method to allow or disallow adding of reference layers to the combo box.
Parameters: b [in] If truen then reference layer names are added to combo box; otherwise they are not.
Returns: Returns the previous value.
See Also: CRhinoUiOptionsListCtrlColorComboBox::PopulateComboBox() CRhinoUiOptionsListCtrlColorComboBox::IncludeReferenceLayers()
|
virtual |
Description: This method is used to set text value for this item. This value is displayed in the right column of the options list control.
Parameters: lps [in] New display text for this item.
See Also: CRhinoUiOptionsListCtrl::Text() CRhinoUiOptionsListCtrl::DrawItemText()
Reimplemented from CRhinoUiOptionsListCtrlColorComboBox.
bool CRhinoUiOptionsListCtrlLayerComboBox::SetUseSortedList | ( | bool | b | ) |
Description: Call this method to control what layerers get added to the combo box. If this is set to true then the sorted and culled list displayed in the layer dialog is used. If this set set to false then the entire layer list is used. SetIncludeReferenceLayers() and SetIncludeDeletedLayers() are used in either case to filter the display of those layer types.
Parameters: b [in] If true then the layer dialog list is used.
Returns: Returns the previous value.
See Also: CRhinoUiOptionsListCtrlColorComboBox::IncludeDeletedLayers() CRhinoUiOptionsListCtrlColorComboBox::IncludeReferenceLayers() CRhinoUiOptionsListCtrlColorComboBox::PopulateComboBox()
bool CRhinoUiOptionsListCtrlLayerComboBox::UseSortedList | ( | ) | const |
Description: This method is called by PopulateComboBox() when adding layers to the combo box. If this is set to true then CRhinoLayerTable::GetSortedList is called otherwise all layers are included.
Returns: Returns true if sorted layer list should be used; otherwise complete layer list will be used.
See Also: CRhinoUiOptionsListCtrlColorComboBox::IncludeDeletedLayers() CRhinoUiOptionsListCtrlColorComboBox::IncludeReferenceLayers() CRhinoUiOptionsListCtrlColorComboBox::PopulateComboBox()