soui 5.0.0.1
Soui5 Doc
 
Loading...
Searching...
No Matches
IFontS Struct Reference

Font object interface. More...

#include <SRender-i.h>

Inheritance diagram for IFontS:
IRenderObj IObjRef

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.
 
IRenderFactoryGetRenderFactory () SCONST PURE
 Obtains the render factory that created this rendering object.
 
OBJTYPE ObjectType () SCONST PURE
 Queries the type of the rendering object.
 
const LOGFONT * LogFont () SCONST PURE
 Retrieves the LOGFONT structure of the font.
 
LPCTSTR FamilyName () SCONST PURE
 Retrieves the family name of the font.
 
int TextSize () SCONST PURE
 Retrieves the text size of the font.
 
BOOL IsBold () SCONST PURE
 Checks if the font is bold.
 
BOOL IsUnderline () SCONST PURE
 Checks if the font has an underline.
 
BOOL IsItalic () SCONST PURE
 Checks if the font is italic.
 
BOOL IsStrikeOut () SCONST PURE
 Checks if the font has a strikeout.
 
BOOL UpdateFont (const LOGFONT *pLogFont) PURE
 Updates the font properties.
 
void SetProp (IXmlNode *pXmlNode) PURE
 Sets properties from an XML node.
 
- 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.
 
IRenderFactoryGetRenderFactory () 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

Font object interface.

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

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

Member Function Documentation

◆ AddRef()

long IFontS::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.

◆ FamilyName()

LPCTSTR IFontS::FamilyName ( )

Retrieves the family name of the font.

Returns the family name of the font.

Returns
LPCTSTR The family name of the font.

◆ GetRenderFactory()

IRenderFactory * IFontS::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.

◆ IsBold()

BOOL IFontS::IsBold ( )

Checks if the font is bold.

Returns a boolean indicating whether the font is bold.

Returns
BOOL TRUE if the font is bold, FALSE otherwise.

◆ IsItalic()

BOOL IFontS::IsItalic ( )

Checks if the font is italic.

Returns a boolean indicating whether the font is italic.

Returns
BOOL TRUE if the font is italic, FALSE otherwise.

◆ IsStrikeOut()

BOOL IFontS::IsStrikeOut ( )

Checks if the font has a strikeout.

Returns a boolean indicating whether the font has a strikeout.

Returns
BOOL TRUE if the font has a strikeout, FALSE otherwise.

◆ IsUnderline()

BOOL IFontS::IsUnderline ( )

Checks if the font has an underline.

Returns a boolean indicating whether the font has an underline.

Returns
BOOL TRUE if the font has an underline, FALSE otherwise.

◆ LogFont()

const LOGFONT * IFontS::LogFont ( )

Retrieves the LOGFONT structure of the font.

Returns a pointer to the LOGFONT structure defining the font attributes.

Returns
const LOGFONT* Pointer to the LOGFONT structure.

◆ ObjectType()

OBJTYPE IFontS::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 IFontS::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 IFontS::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.

◆ SetProp()

void IFontS::SetProp ( IXmlNode * pXmlNode)

Sets properties from an XML node.

Sets the font properties based on the attributes specified in the XML node.

Parameters
pXmlNodePointer to the XML node containing the font properties.

◆ TextSize()

int IFontS::TextSize ( )

Retrieves the text size of the font.

Returns the text size of the font.

Returns
int The text size of the font.

◆ UpdateFont()

BOOL IFontS::UpdateFont ( const LOGFONT * pLogFont)

Updates the font properties.

Updates the font properties using the specified LOGFONT structure.

Parameters
pLogFontPointer to the LOGFONT structure defining the new font attributes.
Returns
BOOL TRUE if the update was successful, FALSE otherwise.

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