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

VCF::CommonColorDialog Class Reference

The CommonColorDialog is used to present a standard dialog for selcting a color. More...

#include <vcf/ApplicationKit/CommonColorDialog.h>

Inheritance diagram for VCF::CommonColorDialog:

VCF::CommonDialog VCF::Component VCF::ObjectWithCallbacks VCF::Object List of all members.

Public Member Functions

 CommonColorDialog (Control *owner=NULL)
 Creates a color dialog.
virtual ~CommonColorDialog ()
virtual bool execute ()
 "executes" the dialog - this will cause the dialog to be displayed.
ColorgetSelectedColor ()
 Returns the color the user selected.
void setSelectedColor (Color *selectedColor)
 Sets the selected color.

Detailed Description

The CommonColorDialog is used to present a standard dialog for selcting a color.

This uses the windowing platform's standard color dialog.


Constructor & Destructor Documentation

VCF::CommonColorDialog::CommonColorDialog Control owner = NULL  ) 
 

Creates a color dialog.

If the owner is NULL then the dialog is non modal. If the owner is not NULL then the dialog is modal relative to the control that started it. For most cases you do not want to pass in a NULL owner.

virtual VCF::CommonColorDialog::~CommonColorDialog  )  [virtual]
 


Member Function Documentation

virtual bool VCF::CommonColorDialog::execute  )  [virtual]
 

"executes" the dialog - this will cause the dialog to be displayed.

Returns:
bool returns true if the user succesfully chose a color, otherwise false if no color was chosen, or the user canceled the dialog.

Implements VCF::CommonDialog.

Color* VCF::CommonColorDialog::getSelectedColor  ) 
 

Returns the color the user selected.

void VCF::CommonColorDialog::setSelectedColor Color selectedColor  ) 
 

Sets the selected color.

This is generally called before the dialog is displayed with the execute() function.


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