Rhino C++ API
8.10
|
#include <RhRdkAutomaticUI.h>
Public Types | |
enum | : unsigned int { Generic = 0x0000, ForContent = 0x0001 } |
enum | Styles : unsigned int { Styles::Plain, Styles::Flat, Styles::Sunken, Styles::Table } |
Public Member Functions | |
virtual | ~IRhRdkAutomaticUI () |
virtual void | AddSection (CRhRdkControllerPtr con, unsigned int flags, int id, const wchar_t *wszLocalCaption, const wchar_t *wszEnglishCaption, bool bExpand, IRhRdkHeaderButtonHandler *pHBH=nullptr)=0 |
virtual RDK_DEPRECATED void | AddSection (int, class IRhRdkParamTransport *, bool, bool, IRhRdkHeaderButtonHandler *=nullptr) |
virtual void | DisplayData (void)=0 |
virtual void * | EVF (const wchar_t *, void *)=0 |
virtual IRhinoUiHolder * | Holder (void) const =0 |
virtual bool | IsSectionExpanded (const UUID &uuidSection) const =0 |
virtual bool | IsSectionExpanded (int id) const =0 |
virtual bool | IsSectionHidden (int id) const =0 |
virtual void | Move (const ON_4iRect &rect, bool bRepaint=true)=0 |
virtual void | RemoveAllSections (void)=0 |
virtual int | SectionCount (void) const =0 |
virtual bool | SectionExists (int id) const =0 |
virtual void | SetBackgroundColor (COLORREF col) const =0 |
virtual void | SetSectionExpanded (const UUID &uuidSection, bool bExpanded, bool bEnsureVisible) const =0 |
virtual void | SetSectionExpanded (int id, bool bExpanded, bool bEnsureVisible) const =0 |
virtual bool | SetSectionHidden (int id, bool bHidden)=0 |
virtual void | SetTextWhenBlank (const wchar_t *wszText)=0 |
This interface allows you to use RDK's automatic user interface services from your RDK plug-in.
Call RhRdkNewAutomaticUI() to get a pointer to this interface. It represents the main user interface window. This window is the holder for any number of sections which can be added by calling AddSection(). Non-automatic sections can be added by calling Holder() and using the returned interface.
|
strong |
|
inlinevirtual |
|
pure virtual |
Add an automatic parameter section to the UI.
con | is the controller for the section. |
flags | specifies flags from the enum above. |
id | is a caller-defined identifier. |
wszLocalCaption | is the localized caption of the section. |
wszEnglishCaption | is the English caption of the section. |
bExpand | is true if the section should be initially expanded. This only works the very first time the section is used because the state is persistent. This flag will be removed in a future version of the SDK. |
pHBH | is an optional handler for header buttons. The RDK takes ownership of the handler. |
|
virtual |
This method is deprecated in favor of the one below. NOT IMPLEMENTED.
|
pure virtual |
Calls DisplayData() on all the UI sections.
|
pure virtual |
Emergency virtual function for future expansion.
|
pure virtual |
Get the section holder. Only works for XP-Style sections.
|
pure virtual |
uuidSection | is the identifier of the section to check. |
|
pure virtual |
id | is the caller-defined identifier of the automatic section to check. |
|
pure virtual |
id | is the caller-defined identifier of the automatic section to check. |
|
pure virtual |
Move the UI's window.
rect | is the rect to move to in client coordinates of the parent window. |
|
pure virtual |
Remove all the sections from the UI.
|
pure virtual |
|
pure virtual |
id | is the caller-defined identifier of the automatic section to check. |
|
pure virtual |
Set the background color of the entire UI. Has no effect on XP style sections.
|
pure virtual |
Sets a section as expanded or collapsed.
uuidSection | is the identifier of the section to change. |
|
pure virtual |
Sets a section as expanded or collapsed.
id | is the caller-defined identifier of the automatic section to change. |
|
pure virtual |
Set an automatic section as hidden.
id | is the caller-defined identifier of the automatic section to set. |
bHidden | is true to hide the section, else false. |
|
pure virtual |
Set the text to display when the UI is blank.