Planeshift
Public Member Functions | Static Public Member Functions

pawsYesNoBox Class Reference

This is a yes/no box used to do confirms. More...

#include <pawsyesnobox.h>

List of all members.

Public Member Functions

void Hide ()
 Makes widget invisible and removes focus if widget has current focus.
bool OnButtonReleased (int mouseButton, int keyModifier, pawsWidget *widget)
 Called whenever a button is released.
 pawsYesNoBox ()
 pawsYesNoBox (const pawsYesNoBox &origin)
bool PostSetup ()
 This is called after the widget and all of it's children have been created.
void SetCallBack (YesNoResponseFunc handler, void *owner, const char *text)
void SetID (int yes=CONFIRM_YES, int no=CONFIRM_NO)
void SetNotify (pawsWidget *widget)
void SetText (const char *text)
virtual ~pawsYesNoBox ()

Static Public Member Functions

static pawsYesNoBoxCreate (pawsWidget *notify, const csString &text, int yesID=CONFIRM_YES, int noID=CONFIRM_NO)
 Static function that creates and sets up pawsYesNoBox:

Detailed Description

This is a yes/no box used to do confirms.

Definition at line 41 of file pawsyesnobox.h.


Constructor & Destructor Documentation

pawsYesNoBox::pawsYesNoBox ( )
pawsYesNoBox::pawsYesNoBox ( const pawsYesNoBox origin)
virtual pawsYesNoBox::~pawsYesNoBox ( ) [virtual]

Member Function Documentation

static pawsYesNoBox* pawsYesNoBox::Create ( pawsWidget notify,
const csString &  text,
int  yesID = CONFIRM_YES,
int  noID = CONFIRM_NO 
) [static]

Static function that creates and sets up pawsYesNoBox:

void pawsYesNoBox::Hide ( ) [virtual]

Makes widget invisible and removes focus if widget has current focus.

Sets visible FALSE, hides border if present and then if focused when called it calls SetCurrentFocusedWidget(NULL).

Reimplemented from pawsWidget.

bool pawsYesNoBox::OnButtonReleased ( int  button,
int  keyModifier,
pawsWidget widget 
) [virtual]

Called whenever a button is released.

Parameters:
buttonThe button released.
keyModifierModifier key in effect.
widgetThe widget the button belongs to.
Returns:
bool Parent's result or FALSE if no parent.

Reimplemented from pawsWidget.

bool pawsYesNoBox::PostSetup ( ) [virtual]

This is called after the widget and all of it's children have been created.

Remarks:
This can be useful for widgets that want to get pointers to some of it's children for quick access.

Reimplemented from pawsWidget.

void pawsYesNoBox::SetCallBack ( YesNoResponseFunc  handler,
void *  owner,
const char *  text 
)
void pawsYesNoBox::SetID ( int  yes = CONFIRM_YES,
int  no = CONFIRM_NO 
)
void pawsYesNoBox::SetNotify ( pawsWidget widget)
void pawsYesNoBox::SetText ( const char *  text)

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