Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::MessageDialog Class Reference

the MessageDialog class let the user to create at run time a dialog with many options for customization. More...

#include <vcf/ApplicationKit/MessageDialog.h>

Inheritance diagram for VCF::MessageDialog:

VCF::Dialog VCF::Frame VCF::Control VCF::DelegatedContainer< Frame > VCF::UIComponent VCF::AbstractView VCF::Component VCF::View VCF::ObjectWithCallbacks VCF::Object List of all members.

Public Member Functions

 MessageDialog ()
virtual ~MessageDialog ()
virtual UIToolkit::ModalReturnType showModal ()
 This is overridden to verify the following conditions: 1) message_ is NOT empty (i.e.
virtual void show ()
 Like the showModal() method, this is overridden to verify the same conditions as showModal().
void addActionButton (const String &caption, const UIToolkit::ModalReturnType returnVal, const bool &defaultButton=false)
 this adds a standard native button
PushButtonaddPushButton (const String &caption, const UIToolkit::ModalReturnType returnVal, const bool &defaultButton=false)
 this let to add a push button with images and other capabilities
String getMessage ()
void setMessage (const String &message)
String getInformation ()
void setInformation (const String &information)
ImagegetApplicationIcon ()
void setApplicationIcon (Image *icon)

Protected Member Functions

void verifyUIState ()
 verifies the state of the dialog as described by showModal();

Protected Attributes

bool showTitle_
String message_
String information_
Dialog::MessageStyle style_
ImageapplicationIcon_
LabelmessageLabel_
LabelinfoLabel_
std::vector< Button * > buttons_
PanelimagePane_
PanellabelsPane_
PanelcommandPane_

Detailed Description

the MessageDialog class let the user to create at run time a dialog with many options for customization.

Like captions and images for the buttons.


Constructor & Destructor Documentation

VCF::MessageDialog::MessageDialog  ) 
 

virtual VCF::MessageDialog::~MessageDialog  )  [virtual]
 


Member Function Documentation

void VCF::MessageDialog::addActionButton const String caption,
const UIToolkit::ModalReturnType  returnVal,
const bool &  defaultButton = false
 

this adds a standard native button

PushButton* VCF::MessageDialog::addPushButton const String caption,
const UIToolkit::ModalReturnType  returnVal,
const bool &  defaultButton = false
 

this let to add a push button with images and other capabilities

Image* VCF::MessageDialog::getApplicationIcon  )  [inline]
 

String VCF::MessageDialog::getInformation  )  [inline]
 

String VCF::MessageDialog::getMessage  )  [inline]
 

void VCF::MessageDialog::setApplicationIcon Image icon  ) 
 

void VCF::MessageDialog::setInformation const String information  ) 
 

void VCF::MessageDialog::setMessage const String message  ) 
 

virtual void VCF::MessageDialog::show  )  [virtual]
 

Like the showModal() method, this is overridden to verify the same conditions as showModal().

See showModal() for more information

Reimplemented from VCF::Dialog.

virtual UIToolkit::ModalReturnType VCF::MessageDialog::showModal  )  [virtual]
 

This is overridden to verify the following conditions: 1) message_ is NOT empty (i.e.

eqivalent to "" ). If it is, a InvalidMessageDialogException is thrown.

2) information_ is NOT empty. If it is, a InvalidMessageDialogException is thrown.

3) buttons_ is not empty. If it is then we have no buttons - not a good sign, which means that a InvalidMessageDialogException will be thrown.

4) applicationIcon_ is NON NULL. If it is NULL then depending on value of style_ a standard icon image is assigned to it. If it is NOT NULL then if the style_ is Dialog::msDefault, the image is displayed normally. If the style_ is Dialog::msError, Dialog::msQuestion, Dialog::msInfo, or Dialog::msWarning, then the standard icon for the value is displayed normal size, while the applicationIcon_ is shrunk by 50% and superimposed on top of the standard image, aligned in the lower bottom right hand corner. The standard dimensions of the icon are windowing system dependent, but in general on Win32 systems the size is 32 X 32, and on MacOSX it would be 64 X 64 pixels.

Reimplemented from VCF::Dialog.

void VCF::MessageDialog::verifyUIState  )  [protected]
 

verifies the state of the dialog as described by showModal();


Member Data Documentation

Image* VCF::MessageDialog::applicationIcon_ [protected]
 

std::vector<Button*> VCF::MessageDialog::buttons_ [protected]
 

Panel* VCF::MessageDialog::commandPane_ [protected]
 

Panel* VCF::MessageDialog::imagePane_ [protected]
 

Label* VCF::MessageDialog::infoLabel_ [protected]
 

String VCF::MessageDialog::information_ [protected]
 

Panel* VCF::MessageDialog::labelsPane_ [protected]
 

String VCF::MessageDialog::message_ [protected]
 

Label* VCF::MessageDialog::messageLabel_ [protected]
 

bool VCF::MessageDialog::showTitle_ [protected]
 

Dialog::MessageStyle VCF::MessageDialog::style_ [protected]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information