IPenS Struct Reference

Pen object interface. More...

#include <SRender-i.h>

Inheritance diagram for IPenS:

Public Member Functions
long	AddRef () PURE
	Increments the reference count for the object.
long	Release () PURE
	Decrements the reference count for the object.
void	OnFinalRelease () PURE
	Called when the final release of the object occurs.
IRenderFactory *	GetRenderFactory () SCONST PURE
	Obtains the render factory that created this rendering object.
OBJTYPE	ObjectType () SCONST PURE
	Queries the type of the rendering object.
int	GetWidth () SCONST PURE
	Retrieves the width of the pen.
void	SetWidth (int nWid) PURE
	Sets the width of the pen.
int	GetStyle () SCONST PURE
	Retrieves the style of the pen.
void	SetStyle (int nStyle) PURE
	Sets the style of the pen.
COLORREF	GetColor () SCONST PURE
	Retrieves the color of the pen.
void	SetColor (COLORREF cr) PURE
	Sets the color of the pen.
Public Member Functions inherited from IRenderObj
long	AddRef () PURE
	Increments the reference count for the object.
long	Release () PURE
	Decrements the reference count for the object.
void	OnFinalRelease () PURE
	Called when the final release of the object occurs.
IRenderFactory *	GetRenderFactory () SCONST PURE
	Obtains the render factory that created this rendering object.
OBJTYPE	ObjectType () SCONST PURE
	Queries the type of the rendering object.
Public Member Functions inherited from IObjRef
long	AddRef () PURE
	Increases the reference count.
long	Release () PURE
	Decreases the reference count.
void	OnFinalRelease () PURE
	Called when the reference count reaches zero and the object is about to be released.

Detailed Description

Pen object interface.

This interface represents a pen used for rendering operations. It inherits from the IRenderObj interface and provides methods to manage the pen's properties and lifecycle.

Definition at line 306 of file SRender-i.h.

Member Function Documentation

AddRef()

long IPenS::AddRef

(

)

Increments the reference count for the object.

This method is used to increase the reference count of the object, ensuring it remains valid as long as references exist.

Returns

long The new reference count after incrementing.

GetColor()

COLORREF IPenS::GetColor

(

)

Retrieves the color of the pen.

Returns the current color of the pen.

Returns

COLORREF The color of the pen.

GetRenderFactory()

IRenderFactory * IPenS::GetRenderFactory

(

)

Obtains the render factory that created this rendering object.

Retrieves a pointer to the render factory responsible for creating this object.

Returns

IRenderFactory* Pointer to the render factory.

GetStyle()

int IPenS::GetStyle

(

)

Retrieves the style of the pen.

Returns the current style of the pen.

Returns

int The style of the pen.

GetWidth()

int IPenS::GetWidth

(

)

Retrieves the width of the pen.

Returns the current width of the pen.

Returns

int The width of the pen.

ObjectType()

OBJTYPE IPenS::ObjectType

(

)

Queries the type of the rendering object.

Returns an enumeration value representing the type of the object (e.g., brush, pen, bitmap).

Returns

OBJTYPE The type of the rendering object.

OnFinalRelease()

void IPenS::OnFinalRelease

(

)

Called when the final release of the object occurs.

This method is invoked when the reference count reaches zero, allowing for any necessary cleanup before the object is destroyed.

Release()

long IPenS::Release

(

)

Decrements the reference count for the object.

This method decreases the reference count of the object. When the count reaches zero, the object may be released.

Returns

long The new reference count after decrementing.

SetColor()

void IPenS::SetColor

(

COLORREF

cr

)

Sets the color of the pen.

Sets the color of the pen to the specified value.

Parameters

cr	The new color of the pen.

SetStyle()

void IPenS::SetStyle

(

int

nStyle

)

Sets the style of the pen.

Sets the style of the pen to the specified value.

Parameters

nStyle

The new style of the pen.

SetWidth()

void IPenS::SetWidth

(

int

nWid

)

Sets the width of the pen.

Sets the width of the pen to the specified value.

Parameters

nWid	The new width of the pen.

---

The documentation for this struct was generated from the following file:

• SOUI/include/interface/SRender-i.h