VCF::AbstractPropertyEditor Class Reference
#include <vcf/ApplicationKit/AbstractPropertyEditor.h>
Inheritance diagram for VCF::AbstractPropertyEditor:
Public Member Functions | |
| AbstractPropertyEditor () | |
| virtual | ~AbstractPropertyEditor () |
| virtual void | setProperty (Property *property) |
| This sets the current property instance for the property editor. | |
| virtual int | getAttributes () |
| This method returns a mask of potential attributes. | |
| virtual Control * | createEditingControl () |
| Returns a control instance that belongs to this editor. | |
| virtual void | edit () |
| This method is used to edit the property value. | |
| virtual void | paintValue (VariantData *value, GraphicsContext *context, const Rect &bounds, const DrawUIState &state) |
| Paints a representation of the editor. | |
| virtual VariantData * | getValue () |
| Returns the value for the property. | |
| virtual void | setValue (VariantData *value) |
| Set's the value on the property editor. | |
| virtual String | getValueAsText () |
| Like getValue(), but this returns the value in text format. | |
| virtual void | setValueAsText (const String &textValue) |
| Like setValue() but allows the value to be a string. | |
| virtual std::vector< String > | getStringValues () |
| Returns an array of potential values for the property. | |
| virtual std::vector< PropertyEditor * > | getSubProperties () |
| Returns a array of proeprty editors from the current value of this editor. | |
| bool | sort (const String &strVal1, const String &strVal2) |
| only implement this if sortValues() returns true. | |
| virtual String | getPropertyDescription () |
| This returns a string that describes the property. | |
| virtual String | getPropertyName () |
| This returns a string that describes the property. | |
| virtual bool | equalTo (PropertyEditor *editor) |
| This method needs to be oveeriden so to specify when two PropertyEditor(s) can be considered equal. | |
| virtual String | getPropertyType () |
| Returns the property type that this editor instance is associated with. | |
| virtual void | internal_setPropertyType (const String &type) |
| Don't call this - this is used strictly by the framework. | |
| virtual Component * | getRootDesignerComponent () |
| returns the root component that is being edited in a form designer. | |
| virtual void | setRootDesignerComponent (Component *rootDesigner) |
| Sets the root component that is being edited in a form designer. | |
Protected Attributes | |
| Property * | property_ |
| int | attributes_ |
| VariantData | data_ |
| String | propertyType_ |
| String | propertyDescription_ |
| String | propertyName_ |
| Component * | rootDesignerComponent_ |
Constructor & Destructor Documentation
|
|
|
|
|
|
Member Function Documentation
|
|
Returns a control instance that belongs to this editor. This control instance is managed by the tool using this property editor so you just need to create it. This may be called multiple times, it is the callers responsibility to delete the control, the editor implementor does not need to worry about this. For simple editors this may return null which will mean the implementation of the UI conntrol is up to the host environment. Typically editors for things like numbers, text, etc, will by default use an edit control or, if the property editor support a list of values, a combo box.
Implements VCF::PropertyEditor. |
|
|
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. Implements VCF::PropertyEditor. Reimplemented in VCF::ColorPropertyEditor, VCF::FontPropertyEditor, VCF::ImageFilenamePropertyEditor, and VCF::ImagePropertyEditor. |
|
|
This method needs to be oveeriden so to specify when two PropertyEditor(s) can be considered equal.
Implements VCF::PropertyEditor. |
|
|
This method returns a mask of potential attributes.
Implements VCF::PropertyEditor. |
|
|
This returns a string that describes the property. A host that displays a UI should first try and call the property's Property::getDescription() method. If this returns an empty string, then the host should call the property editor's getPropertyDescription(). Implements VCF::PropertyEditor. |
|
|
This returns a string that describes the property. A host that displays a UI should first try and call the property's Property::getName() method. If this returns an empty string, then the host should call the property editor's getPropertyName(). Implements VCF::PropertyEditor. |
|
|
Returns the property type that this editor instance is associated with.
Implements VCF::PropertyEditor. |
|
|
returns the root component that is being edited in a form designer. This may or may not be a control. Implements VCF::PropertyEditor. |
|
|
Returns an array of potential values for the property. Only usable if the PropertEditor::paHasValues bit is set.
Implements VCF::PropertyEditor. Reimplemented in VCF::BoolPropertyEditor, VCF::EnumPropertyEditor, VCF::CursorPropertyEditor, and VCF::ColorPropertyEditor. |
|
|
Returns a array of proeprty editors from the current value of this editor. The requirement, of course, is that the variant data that is returned by getValue() is a pdObject. This is not meaningful to call unless PropertEditor::paHasSubProperties is set.
Implements VCF::PropertyEditor. Reimplemented in VCF::EnumSetPropertyEditor, and VCF::FontPropertyEditor. |
|
|
Returns the value for the property. Note that this value is completely independant of the actual value that may be crurently stored in the source object's property. The assignment of this value to the source's property is up to the tool/IDE/etc that is using this interface. Implements VCF::PropertyEditor. |
|
|
Like getValue(), but this returns the value in text format. This value is used for display purposes if the editor doesn't support custom painting. Implements VCF::PropertyEditor. Reimplemented in VCF::EnumSetPropertyEditor, and VCF::CursorPropertyEditor. |
|
|
Don't call this - this is used strictly by the framework.
Implements VCF::PropertyEditor. |
|
||||||||||||||||||||
|
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. Implements VCF::PropertyEditor. Reimplemented in VCF::ColorPropertyEditor, and VCF::FontPropertyEditor. |
|
|
This sets the current property instance for the property editor. This should only get called if the property editor has the paEditorRequestsProperty attribute set. Implements VCF::PropertyEditor. |
|
|
Sets the root component that is being edited in a form designer. This may or may not be a control. This root component is then used by some property editor's to enumerator choices for assign values to properties. For example a component proeprty editor might try and find all sub components of the root component whose class name matches a certain criteria and disply these as possible choices to assign a value to the property editor. Implements VCF::PropertyEditor. |
|
|
Set's the value on the property editor.
Implements VCF::PropertyEditor. |
|
|
Like setValue() but allows the value to be a string.
Implements VCF::PropertyEditor. Reimplemented in VCF::CursorPropertyEditor, and VCF::ColorPropertyEditor. |
|
||||||||||||
|
only implement this if sortValues() returns true. If this is the case, then return true if strVal1 is greater than strVal2. Implements VCF::PropertyEditor. Reimplemented in VCF::ColorPropertyEditor. |
Member Data Documentation
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following file:
- vcf/ApplicationKit/AbstractPropertyEditor.h