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

VCF::ColorPropertyEditor Class Reference

#include <vcf/ApplicationKit/DefaultPropertyEditors.h>

Inheritance diagram for VCF::ColorPropertyEditor:

VCF::AbstractPropertyEditor VCF::ObjectWithEvents VCF::PropertyEditor VCF::Object List of all members.

Public Member Functions

 ColorPropertyEditor ()
virtual ~ColorPropertyEditor ()
virtual void paintValue (VariantData *value, GraphicsContext *context, const Rect &bounds, const DrawUIState &state)
 Paints a representation of the editor.
virtual std::vector< StringgetStringValues ()
 Returns an array of potential values for the property.
virtual void edit ()
 This method is used to edit the property value.
virtual bool sort (const String &strVal1, const String &strVal2)
 only implement this if sortValues() returns true.
virtual void setValueAsText (const String &textValue)
 Like setValue() but allows the value to be a string.

Constructor & Destructor Documentation

VCF::ColorPropertyEditor::ColorPropertyEditor  ) 
 

virtual VCF::ColorPropertyEditor::~ColorPropertyEditor  )  [virtual]
 


Member Function Documentation

virtual void VCF::ColorPropertyEditor::edit  )  [virtual]
 

This method is used to edit the property value.

This is an optional method to implement, and only needs to be done if createEditingControl() returns a non null value. If createEditingControl() is NULL then it's assumed that the actual editing process will be completely handled by the host of the property editor.

If the implementor does edit this method, then it's up to the implemementor to properly transfer the contents of the propert value to the control.

Reimplemented from VCF::AbstractPropertyEditor.

virtual std::vector<String> VCF::ColorPropertyEditor::getStringValues  )  [virtual]
 

Returns an array of potential values for the property.

Only usable if the PropertEditor::paHasValues bit is set.

See also:
PropertEditor::paHasValues

Reimplemented from VCF::AbstractPropertyEditor.

virtual void VCF::ColorPropertyEditor::paintValue VariantData value,
GraphicsContext context,
const Rect bounds,
const DrawUIState state
[virtual]
 

Paints a representation of the editor.

This will only get called if needsCustomPaint() method returns true. This is for custom painting of the property editor when it is not being edited.

Reimplemented from VCF::AbstractPropertyEditor.

virtual void VCF::ColorPropertyEditor::setValueAsText const String textValue  )  [virtual]
 

Like setValue() but allows the value to be a string.

Reimplemented from VCF::AbstractPropertyEditor.

virtual bool VCF::ColorPropertyEditor::sort const String strVal1,
const String strVal2
[virtual]
 

only implement this if sortValues() returns true.

If this is the case, then return true if strVal1 is greater than strVal2.

Reimplemented from VCF::AbstractPropertyEditor.


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