pCon.planner Plugin SDK  Version 8.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | List of all members
X3g::Plugin::IMessageBox Interface Reference

Interface for custom message boxes. More...

Public Member Functions

MessageBox::Button Show (MessageBox::Icon pIcon, System::String^ pText, MessageBox::Button pButton0, MessageBox::Button pButton1, MessageBox::Button pButton2, int pDefaultButtonIdx, int pEscapeButtonIdx)
 Show a message box with predefined button types. More...
 
int Show (MessageBox::Icon pIcon, System::String^ pText, System::String^ pButton0, System::String^ pButton1, System::String^ pButton2, int pDefaultButtonIdx, int pEscapeButtonIdx)
 Show a message box. More...
 

Detailed Description

Interface for custom message boxes.

Member Function Documentation

MessageBox::Button X3g::Plugin::IMessageBox::Show ( MessageBox::Icon  pIcon,
System::String^  pText,
MessageBox::Button  pButton0,
MessageBox::Button  pButton1,
MessageBox::Button  pButton2,
int  pDefaultButtonIdx,
int  pEscapeButtonIdx 
)

Show a message box with predefined button types.

Parameters
pIconDictates the Icon and title of the message box.
pTextThe central text for the message box.
pButton0Request one MessageBox::Button to be part of the message box.
pButton1Request one MessageBox::Button to be part of the message box.
pButton2Request one MessageBox::Button to be part of the message box.
pDefaultButtonIdxSpecify which button is focused by default based on their index.
pEscapeButtonIdxSpecify which MessageBox::Button to return, when the user closes the message box.
Returns
The MessageBox::Button enum pressed by the user.
int X3g::Plugin::IMessageBox::Show ( MessageBox::Icon  pIcon,
System::String^  pText,
System::String^  pButton0,
System::String^  pButton1,
System::String^  pButton2,
int  pDefaultButtonIdx,
int  pEscapeButtonIdx 
)

Show a message box.


This method allows custom text for the message and each Button.

Parameters
pIconSet the icon and title of the message box.
pTextThe central text for the message box.
pButton0Text for the left button of the message box.
This parameter is not allowed to be null or an empty String.
pButton1Text for the centered button of the message box.
This parameter is not allowed to be null or an empty String.
pButton2Text for the right button of the message box.
This parameter is not allowed to be null or an empty String.
pDefaultButtonIdxSpecify which button is focused by default based on their index.
pEscapeButtonIdxSpecify which button index to return, when the user closes the message box.
Returns
The index of the clicked button.