Public Member Functions | List of all members
OptionButton Struct Reference

OptionButton represents an option button dialog item in a MicroStation/PowerPlatform dialog box. More...

#include <OptionButton.h>

Inheritance diagram for OptionButton:
DialogItem

Public Member Functions

OptionButtonSubItemP GetSubItem (int index)
 Retrieves an Option Button sub-item from this Option Button item. More...
 
int GetItemCount ()
 Gets the number of sub-items in this Option Button item. More...
 
StatusInt InsertItem (OptionButtonSubItemR item, int subItemIndex)
 Inserts an Option Button sub-item into this Option Button item. If any further. More...
 
StatusInt DeleteItem (int subItemIndex)
 Deletes an Option Button sub-item from this Option Button item. More...
 
StatusInt DeleteAll ()
 Deletes all Option Button sub-items from this Option Button item. More...
 
- Public Member Functions inherited from DialogItem
DialogItemAttributes const & GetAttributes () const
 Returns a reference to the DialogItemAttributes for this DialogItem. More...
 
RscId GetId () const
 Returns the id of this DialogItem. More...
 
int GetItemIndex () const
 Returns the index within the MSDialog of this DialogItem. More...
 
MSDialogP GetDialog () const
 Returns a pointer to the MSDialog that is hosting this DialogItem. More...
 
RawItemHdrP GetRawItem () const
 Returns a pointer to the RawItemHdr associated with this DialogItem. More...
 
BSIRect const & GetRect () const
 Returns a reference to the rectangle for this DialogItem. This rectangle is used for mouse processing. More...
 
RscType GetType () const
 Returns the resource type of this DialogItem. More...
 
bool HasFocus () const
 Determines if an item has focus. More...
 
bool IsEnabled () const
 Determines if an item is enabled. More...
 
bool IsFocusable ()
 Determines if an item is focusable. More...
 
bool IsDisplayable ()
 Determines if an item can be displayed. More...
 
bool IsHidden ()
 Determines if an item is hidden. More...
 
StatusInt Draw (bool eraseFirst=true)
 Redraws an item within the Dialog Box. More...
 
BSIColorDescr const * GetColor (ItemColorType colorType)
 Gets a specific color for the item. More...
 
StatusInt GetLabel (WStringR label)
 Retrieves the text displayed in the label for this item as a WString. More...
 
int GetLabelLength ()
 Retrieves the length in characters of the label for this item. More...
 
int GetLabelWidth (int fontIndex)
 Retrieves the width in pixels of the label for this item. More...
 
GuiLayoutControlP GetLayoutControl ()
 Retrieves the GuiLayoutControl for this item. More...
 
GuiLayoutPropertiesP GetLayoutProperties ()
 Retrieves the GuiLayoutProperties for this item. More...
 
DialogItemP GetNext (bool includeLayoutItems=false)
 Retrieves the next item in the dialog item list. More...
 
DialogItemP GetNextVisible (bool inclusive=false)
 Retrieves the next visible item in the dialog item list. More...
 
DialogItemP GetOwnerItem ()
 Retrieves the DialogItem pointer of the owning dialog item, if any. More...
 
StatusInt GetPopupMenuText (WStringR text)
 Retrieves the text displayed in the Show/Hide PopupMenu. More...
 
DialogItemP GetPrev (bool includeLayoutItems=false)
 Retrieves the previous item in the dialog item list. More...
 
StatusInt GetState (MSValueDescrR state)
 Retrieves this item's external state. This is the value of the application data that the item controls,. More...
 
StatusInt GetValue (MSValueDescrR value)
 Retrieves this item's internal value. This is the value that is used to determine the item's. More...
 
StatusInt GetValue (WStringR value)
 Retrieves the item's internal value as a string. This is the value that is used to determine the item's. More...
 
StatusInt Hide (bool ignoreFocusOutErrors=false)
 Hides an item within the Dialog Box. More...
 
StatusInt Move (Point2dP newPtP, bool redraw=true)
 Moves an item within the Dialog Box. More...
 
StatusInt Obscure ()
 Obscures the item. Unobscure() reverses this process. More...
 
StatusInt PopupClose (bool update)
 Notifies the owner item to close its popup window. More...
 
StatusInt PopupOpen (bool bGrabMouse, Point2dP pPopupPt, MSDialogP *popupDbPP)
 Opens a Popup dialog associated with this item. If the popup should have focus and the mouse then. More...
 
StatusInt ReloadData (bool redraw=true)
 Reloads the item information for this item. More...
 
StatusInt SetBalloonText (WCharCP text, bool bSetPopupText=true)
 Sets the information displayed in the balloon window for this item. More...
 
StatusInt SetColor (ItemColorType colorType, BSIColorDescr *colorP)
 Sets a specific color for the item. More...
 
StatusInt SetDisabledBalloonText (WCharCP text)
 Sets the text to be displayed in the balloon window when this item is disabled. More...
 
StatusInt SetEnabled (bool enabled, bool ignoreFocusOutErrors=false)
 Sets the enabled state (enabled or disabled) of a dialog item. More...
 
StatusInt SetExtent (SextentCP sextent, bool redraw=true)
 Sets the extent (position and size) of an item within the dialog. More...
 
StatusInt SetFlyoverText (WCharCP text)
 Sets the information displayed in the flyover field in the Status Bar for this item. More...
 
StatusInt SetLabel (WCharCP pwString)
 Sets the label of an item. More...
 
StatusInt SetLabelFont (int fontIndex)
 Sets the font used for the label of this item. More...
 
StatusInt SetPopupMenuText (WCharCP text)
 Sets the text displayed in the Show/Hide PopupMenu. More...
 
StatusInt SetState (bool *stateChangedP, bool synchOthers=true)
 Forces the specified item's external state to match its internal value. More...
 
StatusInt SetValue (bool *valueChangedP, MSValueDescrCR newValue)
 Sets the internal value of the specified item to a certain value. More...
 
StatusInt SetValue (bool *valueChangedP, WCharCP newValue)
 Sets the internal value of the specified item to a certain string value. More...
 
StatusInt Show ()
 Shows a previously hidden item. More...
 
StatusInt Synchronize ()
 Forces the appearance of an item to match its external state. This is the opposite. More...
 
StatusInt SynchronizeOthers ()
 Causes a DITEM_MESSAGE_SYNCHRONIZE message to be sent to all items listed in the. More...
 
StatusInt Unobscure ()
 Unobscures the item. The Obscure method obscures the item. More...
 
template<typename T >
GetTypePtr (RscType itemType)
 
 DialogItem ()
 Constructs a DialogItem object. More...
 
 ~DialogItem ()
 Destructs a DialogItem object. More...
 

Additional Inherited Members

- Public Attributes inherited from DialogItem
RscType type
 type of item, ie. RTYPE_PushButton More...
 
RscId id
 id of item More...
 
int itemIndex
 index within parent More...
 
UInt64 itemArg
 item arg More...
 
BSIRect rect
 mouse sensitive/update region of item More...
 
Sextent extent
 Position / size (in dcoord units) More...
 
Point2d origin
 Position (in dcoord units) More...
 
DialogItemAttributes attributes
 Attributes from the resource. More...
 
RawItemHdrrawItemP
 RawItemHdr associated with this DialogItem. More...
 
DialogItemparentDiP
 Parent DialogItem. More...
 

Detailed Description

OptionButton represents an option button dialog item in a MicroStation/PowerPlatform dialog box.

In order to use the OptionButton struct, you must first get an OptionButtonP pointer from a DialogItem using the GetTypePtr or GetItemPtrByTypeAndId template functions. For example:

Member Function Documentation

StatusInt DeleteAll ( )

Deletes all Option Button sub-items from this Option Button item.

Remarks
Required Library : mdlbltin.lib
StatusInt DeleteItem ( int  subItemIndex)

Deletes an Option Button sub-item from this Option Button item.

Parameters
[in]subItemIndexthe index of the item to delete
Remarks
Required Library : mdlbltin.lib
int GetItemCount ( )

Gets the number of sub-items in this Option Button item.

Remarks
Required Library : mdlbltin.lib
OptionButtonSubItemP GetSubItem ( int  index)

Retrieves an Option Button sub-item from this Option Button item.

Remarks
Required Library : mdlbltin.lib
StatusInt InsertItem ( OptionButtonSubItemR  item,
int  subItemIndex 
)

Inserts an Option Button sub-item into this Option Button item. If any further.

Parameters
[in]itemthe item to insert
[in]subItemIndexthe index of the item to insert before, or -1 to append
Remarks
Required Library : mdlbltin.lib

The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.