StringFormat Class Reference

#include <gdiplusstringformat.h>

Inheritance diagram for StringFormat:

Collaboration diagram for StringFormat:

Public Member Functions
	StringFormat (INT formatFlags=0, LANGID language=LANG_NEUTRAL)
	StringFormat (const StringFormat *format)
StringFormat *	Clone () const
	~StringFormat ()
StringAlignment	GetAlignment () const
LANGID	GetDigitSubstitutionLanguage () const
StringDigitSubstitute	GetDigitSubstitutionMethod () const
INT	GetFormatFlags () const
HotkeyPrefix	GetHotkeyPrefix () const
Status	GetLastStatus () const
StringAlignment	GetLineAlignment () const
INT	GetMeasurableCharacterRangeCount () const
INT	GetTabStopCount () const
Status	GetTabStops (INT count, REAL *firstTabOffset, REAL *tabStops) const
StringTrimming	GetTrimming () const
Status	SetAlignment (StringAlignment align)
Status	SetDigitSubstitution (LANGID language, StringDigitSubstitute substitute)
Status	SetFormatFlags (INT flags)
Status	SetHotkeyPrefix (HotkeyPrefix hotkeyPrefix)
Status	SetLineAlignment (StringAlignment align)
Status	SetMeasurableCharacterRanges (INT rangeCount, const CharacterRange *ranges)
Status	SetTabStops (REAL firstTabOffset, INT count, const REAL *tabStops)
Status	SetTrimming (StringTrimming trimming)
Public Member Functions inherited from GdiplusBase
void	operator delete (void *in_pVoid)
void	operator delete[] (void *in_pVoid)
void *	operator new (size_t in_size)
void *	operator new[] (size_t in_size)

Static Public Member Functions
static const StringFormat *	GenericDefault ()
static const StringFormat *	GenericTypographic ()

Protected Member Functions
	StringFormat (GpStringFormat *format, Status status)
Status	SetStatus (Status status) const

Protected Attributes
GpStringFormat *	nativeFormat
Status	lastStatus

Friends
GpStringFormat *&	getNat (const StringFormat *sf)

Detailed Description

Definition at line 22 of file gdiplusstringformat.h.

Constructor & Destructor Documentation

StringFormat() [1/3]

StringFormat::StringFormat ( INT  formatFlags = 0, LANGID  language = LANG_NEUTRAL  )

inline

Definition at line 25 of file gdiplusstringformat.h.

                                                                      : nativeFormat(NULL)
    {
        lastStatus = DllExports::GdipCreateStringFormat(formatFlags, language, &nativeFormat);
    }

StringFormat() [2/3]

StringFormat::StringFormat ( const StringFormat *  format )

inline

Definition at line 30 of file gdiplusstringformat.h.

                                             : nativeFormat(NULL)
    {
        lastStatus = DllExports::GdipCloneStringFormat(format ? format->nativeFormat : NULL, &nativeFormat);
    }

~StringFormat()

StringFormat::~StringFormat ( )

inline

Definition at line 50 of file gdiplusstringformat.h.

    {
        DllExports::GdipDeleteStringFormat(nativeFormat);
    }

StringFormat() [3/3]

StringFormat::StringFormat ( GpStringFormat *  format, Status  status  )

inlineprotected

Definition at line 203 of file gdiplusstringformat.h.

                                                        : nativeFormat(format), lastStatus(status)
    {
    }

Member Function Documentation

Clone()

StringFormat * StringFormat::Clone ( ) const

inline

Definition at line 36 of file gdiplusstringformat.h.

    {
        GpStringFormat *cloneFormat = NULL;
 
        lastStatus = DllExports::GdipCloneStringFormat(nativeFormat, &cloneFormat);
        if (lastStatus != Ok)
            return NULL;
 
        StringFormat *newFormat = new StringFormat(cloneFormat, lastStatus);
        if (!newFormat)
            DllExports::GdipDeleteStringFormat(cloneFormat);
        return newFormat;
    }

GenericDefault()

static const StringFormat * StringFormat::GenericDefault ( )

inlinestatic

Definition at line 56 of file gdiplusstringformat.h.

    {
        return NULL; // FIXME
    }

GenericTypographic()

static const StringFormat * StringFormat::GenericTypographic ( )

inlinestatic

Definition at line 62 of file gdiplusstringformat.h.

    {
        return NULL; // FIXME
    }

GetAlignment()

StringAlignment StringFormat::GetAlignment ( ) const

inline

Definition at line 68 of file gdiplusstringformat.h.

    {
        StringAlignment alignment;
        SetStatus(DllExports::GdipGetStringFormatAlign(nativeFormat, &alignment));
        return alignment;
    }

GetDigitSubstitutionLanguage()

LANGID StringFormat::GetDigitSubstitutionLanguage ( ) const

inline

Definition at line 76 of file gdiplusstringformat.h.

    {
        LANGID language;
        SetStatus(DllExports::GdipGetStringFormatDigitSubstitution(nativeFormat, &language, NULL));
        return language;
    }

GetDigitSubstitutionMethod()

StringDigitSubstitute StringFormat::GetDigitSubstitutionMethod ( ) const

inline

Definition at line 84 of file gdiplusstringformat.h.

    {
        StringDigitSubstitute substitute;
        SetStatus(DllExports::GdipGetStringFormatDigitSubstitution(nativeFormat, NULL, &substitute));
        return substitute;
    }

GetFormatFlags()

INT StringFormat::GetFormatFlags ( ) const

inline

Definition at line 92 of file gdiplusstringformat.h.

    {
        INT flags;
        SetStatus(DllExports::GdipGetStringFormatFlags(nativeFormat, &flags));
        return flags;
    }

GetHotkeyPrefix()

HotkeyPrefix StringFormat::GetHotkeyPrefix ( ) const

inline

Definition at line 100 of file gdiplusstringformat.h.

    {
        HotkeyPrefix hotkeyPrefix;
        SetStatus(DllExports::GdipGetStringFormatHotkeyPrefix(nativeFormat, reinterpret_cast<INT *>(&hotkeyPrefix)));
        return hotkeyPrefix;
    }

GetLastStatus()

Status StringFormat::GetLastStatus ( ) const

inline

Definition at line 108 of file gdiplusstringformat.h.

    {
        return lastStatus;
    }

GetLineAlignment()

StringAlignment StringFormat::GetLineAlignment ( ) const

inline

Definition at line 114 of file gdiplusstringformat.h.

    {
        StringAlignment alignment;
        SetStatus(DllExports::GdipGetStringFormatLineAlign(nativeFormat, &alignment));
        return alignment;
    }

GetMeasurableCharacterRangeCount()

INT StringFormat::GetMeasurableCharacterRangeCount ( ) const

inline

Definition at line 122 of file gdiplusstringformat.h.

    {
        INT count;
        SetStatus(DllExports::GdipGetStringFormatMeasurableCharacterRangeCount(nativeFormat, &count));
        return count;
    }

GetTabStopCount()

INT StringFormat::GetTabStopCount ( ) const

inline

Definition at line 130 of file gdiplusstringformat.h.

    {
        INT count;
        SetStatus(DllExports::GdipGetStringFormatTabStopCount(nativeFormat, &count));
        return count;
    }

GetTabStops()

Status StringFormat::GetTabStops ( INT  count, REAL *  firstTabOffset, REAL *  tabStops  ) const

inline

Definition at line 138 of file gdiplusstringformat.h.

    {
        return SetStatus(DllExports::GdipGetStringFormatTabStops(nativeFormat, count, firstTabOffset, tabStops));
    }

GetTrimming()

StringTrimming StringFormat::GetTrimming ( ) const

inline

Definition at line 144 of file gdiplusstringformat.h.

    {
        StringTrimming trimming;
        SetStatus(DllExports::GdipGetStringFormatTrimming(nativeFormat, &trimming));
        return trimming;
    }

SetAlignment()

Status StringFormat::SetAlignment ( StringAlignment  align )

inline

Definition at line 152 of file gdiplusstringformat.h.

    {
        return SetStatus(DllExports::GdipSetStringFormatAlign(nativeFormat, align));
    }

SetDigitSubstitution()

Status StringFormat::SetDigitSubstitution ( LANGID  language, StringDigitSubstitute  substitute  )

inline

Definition at line 158 of file gdiplusstringformat.h.

    {
        return SetStatus(DllExports::GdipSetStringFormatDigitSubstitution(nativeFormat, language, substitute));
    }

SetFormatFlags()

Status StringFormat::SetFormatFlags ( INT  flags )

inline

Definition at line 164 of file gdiplusstringformat.h.

    {
        return SetStatus(DllExports::GdipSetStringFormatFlags(nativeFormat, flags));
    }

SetHotkeyPrefix()

Status StringFormat::SetHotkeyPrefix ( HotkeyPrefix  hotkeyPrefix )

inline

Definition at line 170 of file gdiplusstringformat.h.

    {
        return SetStatus(DllExports::GdipSetStringFormatHotkeyPrefix(nativeFormat, INT(hotkeyPrefix)));
    }

SetLineAlignment()

Status StringFormat::SetLineAlignment ( StringAlignment  align )

inline

Definition at line 176 of file gdiplusstringformat.h.

    {
        return SetStatus(DllExports::GdipSetStringFormatLineAlign(nativeFormat, align));
    }

SetMeasurableCharacterRanges()

Status StringFormat::SetMeasurableCharacterRanges ( INT  rangeCount, const CharacterRange *  ranges  )

inline

Definition at line 182 of file gdiplusstringformat.h.

    {
        return SetStatus(DllExports::GdipSetStringFormatMeasurableCharacterRanges(nativeFormat, rangeCount, ranges));
    }

SetStatus()

Status StringFormat::SetStatus ( Status  status ) const

inlineprotected

Definition at line 208 of file gdiplusstringformat.h.

    {
        if (status != Ok)
            lastStatus = status;
        return status;
    }

Referenced by GetAlignment(), GetDigitSubstitutionLanguage(), GetDigitSubstitutionMethod(), GetFormatFlags(), GetHotkeyPrefix(), GetLineAlignment(), GetMeasurableCharacterRangeCount(), GetTabStopCount(), GetTabStops(), GetTrimming(), SetAlignment(), SetDigitSubstitution(), SetFormatFlags(), SetHotkeyPrefix(), SetLineAlignment(), SetMeasurableCharacterRanges(), SetTabStops(), and SetTrimming().

SetTabStops()

Status StringFormat::SetTabStops ( REAL  firstTabOffset, INT  count, const REAL *  tabStops  )

inline

Definition at line 188 of file gdiplusstringformat.h.

    {
        return SetStatus(DllExports::GdipSetStringFormatTabStops(nativeFormat, firstTabOffset, count, tabStops));
    }

SetTrimming()

Status StringFormat::SetTrimming ( StringTrimming  trimming )

inline

Definition at line 194 of file gdiplusstringformat.h.

    {
        return SetStatus(DllExports::GdipSetStringFormatTrimming(nativeFormat, trimming));
    }

Friends And Related Function Documentation

getNat

GpStringFormat *& getNat ( const StringFormat *  sf )

friend

Definition at line 217 of file gdiplusstringformat.h.

    {
        return const_cast<StringFormat *>(sf)->nativeFormat;
    }

Member Data Documentation

lastStatus

Status StringFormat::lastStatus

mutableprotected

Definition at line 201 of file gdiplusstringformat.h.

Referenced by Clone(), GetLastStatus(), SetStatus(), and StringFormat().

nativeFormat

GpStringFormat* StringFormat::nativeFormat

protected

Definition at line 200 of file gdiplusstringformat.h.

Referenced by Clone(), GetAlignment(), GetDigitSubstitutionLanguage(), GetDigitSubstitutionMethod(), GetFormatFlags(), GetHotkeyPrefix(), GetLineAlignment(), GetMeasurableCharacterRangeCount(), GetTabStopCount(), GetTabStops(), GetTrimming(), SetAlignment(), SetDigitSubstitution(), SetFormatFlags(), SetHotkeyPrefix(), SetLineAlignment(), SetMeasurableCharacterRanges(), SetTabStops(), SetTrimming(), StringFormat(), and ~StringFormat().

---

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

• sdk/include/psdk/gdiplusstringformat.h