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

Static class to group message box functionality. More...

Public Types

enum  Button {
  Button::NoButton, Button::Ok, Button::Cancel, Button::Yes,
  Button::No, Button::Abort, Button::Retry, Button::Ignore
}
 Default button types. More...
 
enum  Icon {
  Icon::NoIcon, Icon::Information, Icon::Warning, Icon::Error,
  Icon::Question
}
 Icon types and titles available to show for a message box. More...
 

Static Public Member Functions

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

Properties

static IMessageBox^  CustomMessageBox [get, set]
 Set/Get a custom handler for GUI messages. More...
 

Detailed Description

Static class to group message box functionality.

Member Enumeration Documentation

Default button types.

Enumerator
NoButton 

No button request.

Ok 

Ok button.

Cancel 

Cancel button.

Yes 

Yes button.

No 

No button.

Abort 

Abort button.

Retry 

Retry button.

Ignore 

Ignore button.

Icon types and titles available to show for a message box.

Enumerator
NoIcon 

No icon.

Information 

Give the user some information.

Warning 

Show a warning.

Error 

Display an error.

Question 

Formulate a question.

Member Function Documentation

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

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 Button to be part of the message box.
pButton1Request one Button to be part of the message box.
pButton2Request one Button to be part of the message box.
pDefaultButtonIdxSpecify which button is focused by default based on their index.
pEscapeButtonIdxSpecify which Button to return, when the user closes the message box.
Returns
The Button enum pressed by the user.
int X3g::Plugin::MessageBox::Show ( MessageBox::Icon  pIcon,
System::String^  pText,
System::String^  pButton0,
System::String^  pButton1,
System::String^  pButton2,
int  pDefaultButtonIdx,
int  pEscapeButtonIdx 
)
static

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.
void X3g::Plugin::MessageBox::Show ( System::String^  pText)
static

Show a message box with "Ok" button.

Parameters
pTextThe central text for the message box.
void X3g::Plugin::MessageBox::Show ( MessageBox::Icon  pIcon,
System::String^  pText 
)
static

Show a message box with "Ok" button.

Parameters
pIconSet the icon and title of the message box.
pTextThe central text for the message box.

Property Documentation

IMessageBox^ X3g::Plugin::MessageBox::CustomMessageBox
staticgetset

Set/Get a custom handler for GUI messages.