#include <ArServerHandlerPopup.h>
Public Member Functions | |
ArServerHandlerPopupInfo (const ArServerHandlerPopupInfo &popupInfo) | |
Copy constructor. | |
ArServerHandlerPopupInfo (const char *ignoreIdentifier, const char *title, const char *message, ArServerHandlerPopup::PopupType popupType, ArTypes::Byte defaultButtonNumber, ArTypes::Byte escapeButtonNumber, int timeoutInSeconds, const char *timeoutString, const char *button0Label, const char *button0Pressed, const char *button1Label="", const char *button1Pressed="", const char *button2Label="", const char *button2Pressed="") | |
Constructor. | |
const char * | getButton0Label (void) |
Gets the button0Label (the label on the leftmost button, must have a label). | |
const char * | getButton0Pressed (void) |
Gets the button0Pressed (string sent as box disppears if this button is pressed). | |
const char * | getButton1Label (void) |
Gets the button1Label (the label on the middle button, empty string or NULL for no button). | |
const char * | getButton1Pressed (void) |
Gets the button1Pressed (string sent as box disppears if this button is pressed). | |
const char * | getButton2Label (void) |
Gets the button2Label (the label on the right button, empty string or NULL for no button). | |
const char * | getButton2Pressed (void) |
Gets the button2Pressed (string sent as box disppears if this button is pressed). | |
ArTypes::Byte | getDefaultButtonNumber (void) |
Gets the default button number (whats pressed when enter is hit). | |
ArTypes::Byte | getEscapeButtonNumber (void) |
Gets the escape button number (whats pressed when escape is hit). | |
const char * | getIgnoreIdentifier (void) |
Gets the popup identifer (this is used only for ignoring popups, if empty or NULL then it can't be ignored). | |
const char * | getMessage (void) |
Gets the message (the long string that is displayed that explains things). | |
ArServerHandlerPopup::PopupType | getPopupType (void) |
Gets the type (the icon thats displayed and what type of popup it is). | |
int | getTimeout (void) |
Gets the timeout in seconds (0 is never). | |
const char * | getTimeoutString (void) |
Gets the timeout string (the string that is displayed on the popup if timeout occurs). | |
const char * | getTitle (void) |
Gets the title (the title of the popup box). | |
ArServerHandlerPopupInfo & | operator= (const ArServerHandlerPopupInfo &popupInfo) |
Assignment operator. | |
void | setButton0Label (const char *label) |
Sets the button0Label (the label on the leftmost button, must have a label). | |
void | setButton0Pressed (const char *pressed) |
Sets the button0Pressed (string sent as box disppears if this button is pressed). | |
void | setButton1Label (const char *label) |
Sets the button1Label (the label on the middle button, empty string or NULL for no button). | |
void | setButton1Pressed (const char *pressed) |
Sets the button1Pressed (string sent as box disppears if this button is pressed). | |
void | setButton2Label (const char *label) |
Sets the button2Label (the label on the right button, empty string or NULL for no button). | |
void | setButton2Pressed (const char *pressed) |
Sets the button2Pressed (string sent as box disppears if this button is pressed). | |
void | setDefaultButtonNumber (ArTypes::Byte defaultButtonNumber) |
Sets the default button number (whats pressed when enter is hit). | |
void | setEscapeButtonNumber (ArTypes::Byte escapeButtonNumber) |
Sets the escape button number (whats pressed when escape is hit). | |
void | setIgnoreIdentifier (const char *identifier) |
Gets the popup identifer (this is used only for ignoring popups, if empty or NULL then it can't be ignored). | |
void | setMessage (const char *message) |
Sets the message (the long string that is displayed that explains things). | |
void | setPopupType (ArServerHandlerPopup::PopupType popupType) |
Sets the type (the icon thats displayed and what type of popup it is). | |
void | setTimeout (int timeoutInSeconds) |
Sets the timeout in seconds (0 is never). | |
void | setTimeoutString (const char *timeoutString) |
Sets the timeout string (the string that is displayed on the popup if timeout occurs). | |
void | setTitle (const char *title) |
Sets the title (the title of the popup box). | |
virtual | ~ArServerHandlerPopupInfo () |
Destructor. | |
Protected Attributes | |
std::string | myButton0Label |
std::string | myButton0Pressed |
std::string | myButton1Label |
std::string | myButton1Pressed |
std::string | myButton2Label |
std::string | myButton2Pressed |
ArTypes::Byte | myDefaultButtonNumber |
ArTypes::Byte | myEscapeButtonNumber |
std::string | myIgnoreIdentifier |
std::string | myMessage |
ArServerHandlerPopup::PopupType | myPopupType |
int | myTimeout |
std::string | myTimeoutString |
std::string | myTitle |
So there's a message box with the title which has in it the message, and has between 1 and 3 buttons (button0, button1, and button2) with labels of button0Label, button1Label, and button2Label (if the label is empty or NULL then there'll be no button), the default button of defaultButtonNumber (0 - 2) and the escape button number of escapeButtonNumber (0 - 2)... when a button is pushed the
ignoreIdentifier | The identifier to use for ignoring these boxes, this should be NULL or empty if you don't want this particular box to be able to be ignored (if any popup with this identifier is already being ignored this one will be too) | |
title | The title of the box (displayed in the titlebar) | |
message | The string that will be displayed in the message box (the point of the whole thing) | |
popupType | The type of popup this is, which controls the icon displayed, may someday affect behavior | |
defaultButtonPressed | The button that enter defaults to (This should be whatever is most likely) | |
escapeButtonPressed | The button that escape defaults to (this should be doesn't change the state, ie like cancel), this also should be whats returned if the X is hit. | |
button0Label | The label that is displayed on button 0, the leftmost button | |
timeoutInSeconds | the number of seconds we should give people to respond to the popup before timing it out, 0 means leave it up forever (note that no clients may be watching this or no one may be at the console and use this option wisely (way too many untimed out popups could bog down the server)) | |
timeoutString | The string that will be displayed if a timeout happens | |
button0Pressed | The string that will be put into the box if button0 is pressed (this is mainly so that with multiple clients connected the other clients will get feedback) | |
button1Label | The label that is displayed on button 1 (the middle button if there are 3, right button if there are two) | |
button1Pressed | The string that will be put into the box if button1 is pressed (this is mainly so that with multiple clients connected the other clients will get feedback) | |
button2Label | The label that is displayed on button 2 (the right button) | |
button2Pressed | The string that will be put into the box if button2 is pressed (this is mainly so that with multiple clients connected the other clients will get feedback) |
Definition at line 157 of file ArServerHandlerPopup.h.
|
Constructor.
Definition at line 279 of file ArServerHandlerPopup.cpp. References myButton0Label, myButton0Pressed, myButton1Label, myButton1Pressed, myButton2Label, myButton2Pressed, myDefaultButtonNumber, myEscapeButtonNumber, myIgnoreIdentifier, myMessage, myPopupType, myTimeout, myTimeoutString, and myTitle. |
|
Destructor.
Definition at line 342 of file ArServerHandlerPopup.cpp. |
|
Copy constructor.
Definition at line 347 of file ArServerHandlerPopup.cpp. References myButton0Label, myButton0Pressed, myButton1Label, myButton1Pressed, myButton2Label, myButton2Pressed, myDefaultButtonNumber, myEscapeButtonNumber, myIgnoreIdentifier, myMessage, myPopupType, myTimeout, myTimeoutString, and myTitle. |
|
Gets the button0Label (the label on the leftmost button, must have a label).
Definition at line 197 of file ArServerHandlerPopup.h. References myButton0Label. Referenced by ArServerHandlerPopup::createPopup(). |
|
Gets the button0Pressed (string sent as box disppears if this button is pressed).
Definition at line 199 of file ArServerHandlerPopup.h. References myButton0Pressed. Referenced by ArServerHandlerPopup::netPopupClicked(). |
|
Gets the button1Label (the label on the middle button, empty string or NULL for no button).
Definition at line 202 of file ArServerHandlerPopup.h. References myButton1Label. Referenced by ArServerHandlerPopup::createPopup(). |
|
Gets the button1Pressed (string sent as box disppears if this button is pressed).
Definition at line 204 of file ArServerHandlerPopup.h. References myButton1Pressed. Referenced by ArServerHandlerPopup::netPopupClicked(). |
|
Gets the button2Label (the label on the right button, empty string or NULL for no button).
Definition at line 206 of file ArServerHandlerPopup.h. References myButton2Label. Referenced by ArServerHandlerPopup::createPopup(). |
|
Gets the button2Pressed (string sent as box disppears if this button is pressed).
Definition at line 208 of file ArServerHandlerPopup.h. References myButton2Pressed. Referenced by ArServerHandlerPopup::netPopupClicked(). |
|
Gets the default button number (whats pressed when enter is hit).
Definition at line 188 of file ArServerHandlerPopup.h. References myDefaultButtonNumber. Referenced by ArServerHandlerPopup::createPopup(). |
|
Gets the escape button number (whats pressed when escape is hit).
Definition at line 190 of file ArServerHandlerPopup.h. References myEscapeButtonNumber. Referenced by ArServerHandlerPopup::createPopup(). |
|
Gets the popup identifer (this is used only for ignoring popups, if empty or NULL then it can't be ignored).
Definition at line 180 of file ArServerHandlerPopup.h. References myIgnoreIdentifier. Referenced by ArServerHandlerPopup::createPopup(). |
|
Gets the message (the long string that is displayed that explains things).
Definition at line 184 of file ArServerHandlerPopup.h. References myMessage. Referenced by ArServerHandlerPopup::createPopup(). |
|
Gets the type (the icon thats displayed and what type of popup it is).
Definition at line 186 of file ArServerHandlerPopup.h. References myPopupType. Referenced by ArServerHandlerPopup::createPopup(). |
|
Gets the timeout in seconds (0 is never).
Definition at line 192 of file ArServerHandlerPopup.h. References myTimeout. Referenced by ArServerHandlerPopup::serverCycleCallback(). |
|
Gets the timeout string (the string that is displayed on the popup if timeout occurs).
Definition at line 194 of file ArServerHandlerPopup.h. References myTimeoutString. Referenced by ArServerHandlerPopup::serverCycleCallback(). |
|
Gets the title (the title of the popup box).
Definition at line 182 of file ArServerHandlerPopup.h. References myTitle. Referenced by ArServerHandlerPopup::createPopup(). |
|
Assignment operator.
Definition at line 373 of file ArServerHandlerPopup.cpp. References myButton0Label, myButton0Pressed, myButton1Label, myButton1Pressed, myButton2Label, myButton2Pressed, myDefaultButtonNumber, myEscapeButtonNumber, myIgnoreIdentifier, myMessage, myPopupType, myTimeout, myTimeoutString, and myTitle. |
|
Sets the button0Label (the label on the leftmost button, must have a label).
Definition at line 235 of file ArServerHandlerPopup.h. References myButton0Label. |
|
Sets the button0Pressed (string sent as box disppears if this button is pressed).
Definition at line 238 of file ArServerHandlerPopup.h. References myButton0Pressed. |
|
Sets the button1Label (the label on the middle button, empty string or NULL for no button).
Definition at line 241 of file ArServerHandlerPopup.h. References myButton1Label. |
|
Sets the button1Pressed (string sent as box disppears if this button is pressed).
Definition at line 244 of file ArServerHandlerPopup.h. References myButton1Pressed. |
|
Sets the button2Label (the label on the right button, empty string or NULL for no button).
Definition at line 247 of file ArServerHandlerPopup.h. References myButton2Label. |
|
Sets the button2Pressed (string sent as box disppears if this button is pressed).
Definition at line 250 of file ArServerHandlerPopup.h. References myButton2Pressed. |
|
Sets the default button number (whats pressed when enter is hit).
Definition at line 223 of file ArServerHandlerPopup.h. References myDefaultButtonNumber. |
|
Sets the escape button number (whats pressed when escape is hit).
Definition at line 226 of file ArServerHandlerPopup.h. References myEscapeButtonNumber. |
|
Gets the popup identifer (this is used only for ignoring popups, if empty or NULL then it can't be ignored).
Definition at line 211 of file ArServerHandlerPopup.h. References myIgnoreIdentifier. |
|
Sets the message (the long string that is displayed that explains things).
Definition at line 217 of file ArServerHandlerPopup.h. References myMessage. |
|
Sets the type (the icon thats displayed and what type of popup it is).
Definition at line 220 of file ArServerHandlerPopup.h. References myPopupType. |
|
Sets the timeout in seconds (0 is never).
Definition at line 229 of file ArServerHandlerPopup.h. References myTimeout. |
|
Sets the timeout string (the string that is displayed on the popup if timeout occurs).
Definition at line 232 of file ArServerHandlerPopup.h. References myTimeoutString. |
|
Sets the title (the title of the popup box).
Definition at line 214 of file ArServerHandlerPopup.h. References myTitle. |
|
Definition at line 262 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getButton0Label(), operator=(), and setButton0Label(). |
|
Definition at line 263 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getButton0Pressed(), operator=(), and setButton0Pressed(). |
|
Definition at line 264 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getButton1Label(), operator=(), and setButton1Label(). |
|
Definition at line 265 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getButton1Pressed(), operator=(), and setButton1Pressed(). |
|
Definition at line 266 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getButton2Label(), operator=(), and setButton2Label(). |
|
Definition at line 267 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getButton2Pressed(), operator=(), and setButton2Pressed(). |
|
Definition at line 258 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getDefaultButtonNumber(), operator=(), and setDefaultButtonNumber(). |
|
Definition at line 259 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getEscapeButtonNumber(), operator=(), and setEscapeButtonNumber(). |
|
Definition at line 254 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getIgnoreIdentifier(), operator=(), and setIgnoreIdentifier(). |
|
Definition at line 256 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getMessage(), operator=(), and setMessage(). |
|
Definition at line 257 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getPopupType(), operator=(), and setPopupType(). |
|
Definition at line 260 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getTimeout(), operator=(), and setTimeout(). |
|
Definition at line 261 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getTimeoutString(), operator=(), and setTimeoutString(). |
|
Definition at line 255 of file ArServerHandlerPopup.h. Referenced by ArServerHandlerPopupInfo(), getTitle(), operator=(), and setTitle(). |