Invisible Style property that can be added to Canvas Objects. More...

#include <canprop.h>

Inheritance diagram for a2dStyleProperty:

Collaboration diagram for a2dStyleProperty:

Public Member Functions
	a2dStyleProperty (const a2dPropertyId *id)

	a2dStyleProperty (const a2dStyleProperty &other)

a2dNamedProperty *	Clone (a2dObject::CloneOptions options) const

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. More...

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. More...

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. More...

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

Public Member Functions inherited from a2dNamedProperty
	a2dNamedProperty ()
	Default constructor.

	a2dNamedProperty (const a2dPropertyId *id)
	Constructor giving an id.

	a2dNamedProperty (const a2dNamedProperty &other)
	Copy constructor.

a2dNamedProperty *	Clone (a2dObject::CloneOptions options, a2dRefMap *refs=NULL) const
	Virtual copy constructor.

virtual	~a2dNamedProperty ()
	Destructor.

void	SetCheck (bool check)
	general flag use at will. More...

bool	GetCheck () const
	general flag use at will.

void	SetToObject (a2dObject *obj, a2dPropertyId::SetFlags setflags=a2dPropertyId::set_none)
	Set this property to an object. More...

void	SetToObjectClone (a2dObject *obj, a2dPropertyId::SetFlags setflags=a2dPropertyId::set_none) const
	Set this property to an object and clone it if neccessary. More...

const a2dPropertyId *	GetId () const
	Get the a2dPropertyId object identifying this property.

virtual const a2dPropertyId *	CreateId (a2dObject *parent, const wxString &name)
	creates an a2dPropertyId for this property, if it is not available.

wxString	GetName () const
	Get the name of the a2dPropertyId object.

virtual wxString	GetString () const
	when a2dStringProperty, return its value else assert

virtual double	GetDouble () const
	when a2dDoubleProperty, return its value else assert

virtual float	GetFloat () const
	when a2dFloatProperty, return its value else assert

virtual bool	GetBool () const
	when a2dBoolProperty, return its value else assert

virtual wxInt16	GetInt16 () const
	when a2dInt16Property, return its value else assert

virtual wxUint16	GetUint16 () const
	when a2dUint16Property, return its value else assert

virtual wxInt32	GetInt32 () const
	when a2dInt32Property, return its value else assert

virtual wxUint32	GetUint32 () const
	when a2dUint32Property, return its value else assert

virtual void *	GetVoidPtr () const
	when a2dVoidPtrProperty, return its value else assert

virtual a2dObject *	GetRefObject () const
	when a2dProperty, return its value else assert

virtual a2dObject *	GetRefObjectNA () const
	when a2dProperty, return its value else return NULL

virtual bool	GetVisible () const
	some derived properties can be visible or not and override this

virtual bool	GetCanRender () const
	some derived properties can be renderable or not and override this More...

double	ParseDouble (unsigned int &position)
	parse a double from the value string

void	SkipCommaSpaces (unsigned int &position)
	parse comma, whitespace and skip it form teh value string

void	SkipSpaces (unsigned int &position)
	parse whitespace and skip it form teh value string

void	Walker (wxObject *parent, a2dWalkerIOHandler &handler)
	This is used to recursively walk through an object tree.

virtual void	DoWalker (wxObject *parent, a2dWalkerIOHandler &handler)

virtual void	Save (wxObject parent, a2dIOHandlerXmlSerOut &out, a2dObjectList towrite)

virtual void	Load (wxObject *parent, a2dIOHandlerXmlSerIn &parser)

Protected Member Functions
virtual void	DoSave (wxObject parent, a2dIOHandlerXmlSerOut &out, a2dXmlSer_flag xmlparts, a2dObjectList towrite)

virtual void	DoLoad (wxObject *parent, a2dIOHandlerXmlSerIn &parser, a2dXmlSer_flag xmlparts)

Protected Attributes
a2dStroke	m_stroke

a2dFill	m_fill

Protected Attributes inherited from a2dNamedProperty
const a2dPropertyId *	m_id
	The property id object identifying this property.

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 55 of file canprop.h.

Member Function Documentation

const a2dFill& a2dStyleProperty::GetFill ( ) const

inline

Set a fill for the object which will be used instead of the layer fill returns a2dNullFILL set if no fill is used in which case the layer fill is used for filling

Definition at line 76 of file canprop.h.

const a2dStroke& a2dStyleProperty::GetStroke ( ) const

inline

Set a stroke for the object which will be used instead of the layer stroke returns a2dBLACK_STROKE with IsNoStroke() set, if no stroke is used in which case the layer fill is used for stroking

Definition at line 80 of file canprop.h.

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

a2dFill a2dStyleProperty::m_fill

protected

fill used for filling of object. If m_filled object is false the object will not be filled. a2dNullFILL when no fill

Definition at line 142 of file canprop.h.

a2dStroke a2dStyleProperty::m_stroke

protected

stroke used for outline of object. a2dNullSTROKE when no stroke

Definition at line 137 of file canprop.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation