a2dStyleProperty Class Reference
[a2dPropObject holds property objects, objects used for styling a2dCanvasObject's]
Invisible Style property that can be added to Canvas Objects.
More...
#include <canprop.h>
Public Member Functions | |
| a2dStyleProperty (const a2dPropertyId *id) | |
| a2dStyleProperty (const a2dStyleProperty &other) | |
| a2dNamedProperty * | Clone (a2dObject::CloneOptions options) const |
| Virtual copy constructor. | |
| virtual void | Assign (const a2dNamedProperty &other) |
| Virtual assignment operator. | |
| bool | AllNo () |
| if IsNoStroke() and IsNoFill() return true | |
| const a2dFill & | GetFill () const |
| const a2dStroke & | GetStroke () const |
| void | SetFill (const a2dFill &fill) |
| Set a fill for the object which will be used instead of the layer fill. | |
| void | SetFill (const wxColour &fillcolor, a2dFillStyle style=a2dFILL_SOLID) |
| Set a fill color for the object which will be used instead of the layer fill. | |
| void | SetFill (const wxColour &fillcolor, const wxColour &fillcolor2, a2dFillStyle style=a2dFILL_SOLID) |
| Set a fill color for the object which will be used instead of the layer fill. | |
| void | SetStroke (const wxColour &strokecolor, float width=0, a2dStrokeStyle style=a2dSTROKE_SOLID) |
| Set a stroke for the object which will be used instead of the layer stroke. | |
| void | SetStroke (const wxColour &strokecolor, int width, a2dStrokeStyle style=a2dSTROKE_SOLID) |
| Set a stroke for the object which will be used instead of the layer stroke. | |
| void | SetStroke (const a2dStroke &stroke) |
| wxString | StringRepresentation () const |
| wxString | StringValueRepresentation () const |
Protected Member Functions | |
| virtual void | DoSave (wxObject *parent, a2dIOHandlerXmlSerOut &out, a2dXmlSer_flag xmlparts, a2dObjectList *towrite) |
| Save settings. | |
| virtual void | DoLoad (wxObject *parent, a2dIOHandlerXmlSerIn &parser, a2dXmlSer_flag xmlparts) |
| Load settings. | |
Protected Attributes | |
| a2dStroke | m_stroke |
| a2dFill | m_fill |
Detailed Description
Invisible Style property that can be added to Canvas Objects.Rendering is not done on this object. All style like object like a2dStroke and a2dFill are added to a2dCanvasObjects with this property.
Fill Colour being the foreground color if filling with a monochrome bitmap and fill style is a2dFILL_STIPPLE_MASK_OPAQUE. Or in case of gradient filling the beginning colour for the fill
You get transparent bitmap filling when bitmap fill is monochrome and fill style is a2dFILL_STIPPLE_MASK_OPAQUE_TRANSPARENT. The fill colour will be used for non Transparent parts in the fill bitmap, while other parts will be transparent.
colour2 being the background color if filling with a monochrome bitmap and fill style is a2dFILL_STIPPLE_MASK_OPAQUE. Or in case of gradient filling the ending colour for the fill.
- Remarks:
- Fill Second color, used for Text, transparent filling and gradient filling.
style is inhereted from parent object.
an object may have style but is free to use it or not.
Definition at line 53 of file canprop.h.
Member Function Documentation
| const a2dFill& a2dStyleProperty::GetFill | ( | ) | const [inline] |
| const a2dStroke& a2dStyleProperty::GetStroke | ( | ) | const [inline] |
| void a2dStyleProperty::SetFill | ( | const a2dFill & | fill | ) |
Set a fill for the object which will be used instead of the layer fill.
The fill is for filling the a2dCanvasObject. Use IsNoFill() to remove the fill from a a2dCanvasObject. Use a2dTRANSPARENT_FILL to not fill the object.
- Remarks:
- m_flags.m_filled flag overrules the fill to fill TRANSPARENT
Definition at line 110 of file canprop.cpp.
| void a2dStyleProperty::SetFill | ( | const wxColour & | fillcolor, | |
| a2dFillStyle | style = a2dFILL_SOLID | |||
| ) |
Set a fill color for the object which will be used instead of the layer fill.
- Parameters:
-
fillcolor color to fill a2dCanvasObject with style style for one colour fill
- Remarks:
- creates a a2dOneColourFill internal
- See also:
- a2dOneColourFill
Definition at line 115 of file canprop.cpp.
| void a2dStyleProperty::SetFill | ( | const wxColour & | fillcolor, | |
| const wxColour & | fillcolor2, | |||
| a2dFillStyle | style = a2dFILL_SOLID | |||
| ) |
Set a fill color for the object which will be used instead of the layer fill.
- Parameters:
-
fillcolor color to fill a2dCanvasObject with fillcolor2 color to fill a2dCanvasObject with style style for one colour fill
- Remarks:
- creates a a2dTwoColourFill internal
- See also:
- a2dTwoColourFill
Definition at line 120 of file canprop.cpp.
| void a2dStyleProperty::SetStroke | ( | const a2dStroke & | stroke | ) |
The stroke is for drawing outlines of the a2dCanvasObject. Use NoStroke() to remove the stroke from a a2dCanvasObject. Use a2dTRANSPARENT_STROKE to not fill the object.
Definition at line 136 of file canprop.cpp.
| wxString a2dStyleProperty::StringRepresentation | ( | ) | const [virtual] |
Convert the property to a string, used to serialize class. Override to define it for your properties.
Reimplemented from a2dNamedProperty.
Definition at line 90 of file canprop.cpp.
| wxString a2dStyleProperty::StringValueRepresentation | ( | ) | const [virtual] |
Convert the property value to a string, used to serialize class. Override to define it for your properties.
Reimplemented from a2dNamedProperty.
Definition at line 95 of file canprop.cpp.
Member Data Documentation
a2dStroke a2dStyleProperty::m_stroke [protected] |
a2dFill a2dStyleProperty::m_fill [protected] |
The documentation for this class was generated from the following files: