ReactOS  0.4.15-dev-1070-ge1a01de
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)
 
StringFormatClone () 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)
 
voidoperator new (size_t in_size)
 
voidoperator new[] (size_t in_size)
 

Static Public Member Functions

static const StringFormatGenericDefault ()
 
static const StringFormatGenericTypographic ()
 

Protected Member Functions

 StringFormat (GpStringFormat *format, Status status)
 
Status SetStatus (Status status) const
 

Protected Attributes

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

26  {
28  }
GpStringFormat * nativeFormat
smooth NULL
Definition: ftsmooth.c:416
GpStatus WINGDIPAPI GdipCreateStringFormat(INT attr, LANGID lang, GpStringFormat **format)
Definition: stringformat.c:76

Referenced by Clone().

◆ StringFormat() [2/3]

StringFormat::StringFormat ( const StringFormat format)
inline

Definition at line 30 of file gdiplusstringformat.h.

31  {
33  }
GpStringFormat * nativeFormat
GLint GLint GLsizei GLsizei GLsizei GLint GLenum format
Definition: gl.h:1546
smooth NULL
Definition: ftsmooth.c:416
GpStatus WINGDIPAPI GdipCloneStringFormat(GDIPCONST GpStringFormat *format, GpStringFormat **newFormat)
Definition: stringformat.c:369

◆ ~StringFormat()

StringFormat::~StringFormat ( )
inline

Definition at line 50 of file gdiplusstringformat.h.

51  {
53  }
GpStringFormat * nativeFormat
GpStatus WINGDIPAPI GdipDeleteStringFormat(GpStringFormat *format)
Definition: stringformat.c:105

◆ StringFormat() [3/3]

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

Definition at line 203 of file gdiplusstringformat.h.

204  {
205  }
GpStringFormat * nativeFormat
GLint GLint GLsizei GLsizei GLsizei GLint GLenum format
Definition: gl.h:1546
Definition: ps.c:97

Member Function Documentation

◆ Clone()

StringFormat* StringFormat::Clone ( ) const
inline

Definition at line 36 of file gdiplusstringformat.h.

37  {
38  GpStringFormat *cloneFormat = NULL;
39 
41  if (lastStatus != Ok)
42  return NULL;
43 
44  StringFormat *newFormat = new StringFormat(cloneFormat, lastStatus);
45  if (!newFormat)
47  return newFormat;
48  }
GpStringFormat * nativeFormat
StringFormat(INT formatFlags=0, LANGID language=LANG_NEUTRAL)
smooth NULL
Definition: ftsmooth.c:416
GpStatus WINGDIPAPI GdipDeleteStringFormat(GpStringFormat *format)
Definition: stringformat.c:105
GpStatus WINGDIPAPI GdipCloneStringFormat(GDIPCONST GpStringFormat *format, GpStringFormat **newFormat)
Definition: stringformat.c:369

◆ GenericDefault()

static const StringFormat* StringFormat::GenericDefault ( )
inlinestatic

Definition at line 56 of file gdiplusstringformat.h.

57  {
58  return NULL; // FIXME
59  }
smooth NULL
Definition: ftsmooth.c:416

◆ GenericTypographic()

static const StringFormat* StringFormat::GenericTypographic ( )
inlinestatic

Definition at line 62 of file gdiplusstringformat.h.

63  {
64  return NULL; // FIXME
65  }
smooth NULL
Definition: ftsmooth.c:416

◆ GetAlignment()

StringAlignment StringFormat::GetAlignment ( ) const
inline

Definition at line 68 of file gdiplusstringformat.h.

69  {
70  StringAlignment alignment;
72  return alignment;
73  }
GpStringFormat * nativeFormat
StringAlignment
Definition: gdiplusenums.h:263
GpStatus WINGDIPAPI GdipGetStringFormatAlign(GpStringFormat *format, StringAlignment *align)
Definition: stringformat.c:130
Status SetStatus(Status status) const

◆ GetDigitSubstitutionLanguage()

LANGID StringFormat::GetDigitSubstitutionLanguage ( ) const
inline

Definition at line 76 of file gdiplusstringformat.h.

77  {
78  LANGID language;
80  return language;
81  }
GpStringFormat * nativeFormat
GpStatus WINGDIPAPI GdipGetStringFormatDigitSubstitution(GDIPCONST GpStringFormat *format, LANGID *language, StringDigitSubstitute *substitute)
Definition: stringformat.c:141
WORD LANGID
Definition: typedefs.h:81
smooth NULL
Definition: ftsmooth.c:416
Status SetStatus(Status status) const

◆ GetDigitSubstitutionMethod()

StringDigitSubstitute StringFormat::GetDigitSubstitutionMethod ( ) const
inline

Definition at line 84 of file gdiplusstringformat.h.

85  {
86  StringDigitSubstitute substitute;
88  return substitute;
89  }
GpStringFormat * nativeFormat
GpStatus WINGDIPAPI GdipGetStringFormatDigitSubstitution(GDIPCONST GpStringFormat *format, LANGID *language, StringDigitSubstitute *substitute)
Definition: stringformat.c:141
smooth NULL
Definition: ftsmooth.c:416
Status SetStatus(Status status) const
StringDigitSubstitute
Definition: gdiplusenums.h:270

◆ GetFormatFlags()

INT StringFormat::GetFormatFlags ( ) const
inline

Definition at line 92 of file gdiplusstringformat.h.

93  {
94  INT flags;
96  return flags;
97  }
GpStatus WINGDIPAPI GdipGetStringFormatFlags(GDIPCONST GpStringFormat *format, INT *flags)
Definition: stringformat.c:153
GpStringFormat * nativeFormat
int32_t INT
Definition: typedefs.h:58
Status SetStatus(Status status) const
GLbitfield flags
Definition: glext.h:7161

◆ GetHotkeyPrefix()

HotkeyPrefix StringFormat::GetHotkeyPrefix ( ) const
inline

Definition at line 100 of file gdiplusstringformat.h.

101  {
102  HotkeyPrefix hotkeyPrefix;
103  SetStatus(DllExports::GdipGetStringFormatHotkeyPrefix(nativeFormat, reinterpret_cast<INT *>(&hotkeyPrefix)));
104  return hotkeyPrefix;
105  }
GpStringFormat * nativeFormat
HotkeyPrefix
Definition: gdiplusenums.h:311
GpStatus WINGDIPAPI GdipGetStringFormatHotkeyPrefix(GDIPCONST GpStringFormat *format, INT *hkpx)
Definition: stringformat.c:164
Status SetStatus(Status status) const

◆ GetLastStatus()

Status StringFormat::GetLastStatus ( ) const
inline

Definition at line 108 of file gdiplusstringformat.h.

109  {
110  return lastStatus;
111  }

◆ GetLineAlignment()

StringAlignment StringFormat::GetLineAlignment ( ) const
inline

Definition at line 114 of file gdiplusstringformat.h.

115  {
116  StringAlignment alignment;
118  return alignment;
119  }
GpStringFormat * nativeFormat
StringAlignment
Definition: gdiplusenums.h:263
Status SetStatus(Status status) const
GpStatus WINGDIPAPI GdipGetStringFormatLineAlign(GpStringFormat *format, StringAlignment *align)
Definition: stringformat.c:175

◆ GetMeasurableCharacterRangeCount()

INT StringFormat::GetMeasurableCharacterRangeCount ( ) const
inline

Definition at line 122 of file gdiplusstringformat.h.

123  {
124  INT count;
126  return count;
127  }
GpStringFormat * nativeFormat
GLuint GLuint GLsizei count
Definition: gl.h:1545
int32_t INT
Definition: typedefs.h:58
GpStatus WINGDIPAPI GdipGetStringFormatMeasurableCharacterRangeCount(GDIPCONST GpStringFormat *format, INT *count)
Definition: stringformat.c:186
Status SetStatus(Status status) const

◆ GetTabStopCount()

INT StringFormat::GetTabStopCount ( ) const
inline

Definition at line 130 of file gdiplusstringformat.h.

131  {
132  INT count;
134  return count;
135  }
GpStringFormat * nativeFormat
GLuint GLuint GLsizei count
Definition: gl.h:1545
int32_t INT
Definition: typedefs.h:58
GpStatus WINGDIPAPI GdipGetStringFormatTabStopCount(GDIPCONST GpStringFormat *format, INT *count)
Definition: stringformat.c:199
Status SetStatus(Status status) const

◆ GetTabStops()

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

Definition at line 138 of file gdiplusstringformat.h.

139  {
140  return SetStatus(DllExports::GdipGetStringFormatTabStops(nativeFormat, count, firstTabOffset, tabStops));
141  }
GpStringFormat * nativeFormat
GLuint GLuint GLsizei count
Definition: gl.h:1545
GpStatus WINGDIPAPI GdipGetStringFormatTabStops(GDIPCONST GpStringFormat *format, INT count, REAL *firsttab, REAL *tabs)
Definition: stringformat.c:210
Status SetStatus(Status status) const

◆ GetTrimming()

StringTrimming StringFormat::GetTrimming ( ) const
inline

Definition at line 144 of file gdiplusstringformat.h.

145  {
146  StringTrimming trimming;
148  return trimming;
149  }
GpStringFormat * nativeFormat
GpStatus WINGDIPAPI GdipGetStringFormatTrimming(GpStringFormat *format, StringTrimming *trimming)
Definition: stringformat.c:225
StringTrimming
Definition: gdiplusenums.h:291
Status SetStatus(Status status) const

◆ SetAlignment()

Status StringFormat::SetAlignment ( StringAlignment  align)
inline

Definition at line 152 of file gdiplusstringformat.h.

153  {
155  }
GpStringFormat * nativeFormat
int align(int length, int align)
Definition: dsound8.c:36
Status SetStatus(Status status) const
GpStatus WINGDIPAPI GdipSetStringFormatAlign(GpStringFormat *format, StringAlignment align)
Definition: stringformat.c:236

◆ SetDigitSubstitution()

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

Definition at line 158 of file gdiplusstringformat.h.

159  {
161  }
GpStringFormat * nativeFormat
Status SetStatus(Status status) const
GpStatus WINGDIPAPI GdipSetStringFormatDigitSubstitution(GpStringFormat *format, LANGID language, StringDigitSubstitute substitute)
Definition: stringformat.c:250

◆ SetFormatFlags()

Status StringFormat::SetFormatFlags ( INT  flags)
inline

Definition at line 164 of file gdiplusstringformat.h.

165  {
167  }
GpStringFormat * nativeFormat
GpStatus WINGDIPAPI GdipSetStringFormatFlags(GpStringFormat *format, INT flags)
Definition: stringformat.c:357
Status SetStatus(Status status) const
GLbitfield flags
Definition: glext.h:7161

◆ SetHotkeyPrefix()

Status StringFormat::SetHotkeyPrefix ( HotkeyPrefix  hotkeyPrefix)
inline

Definition at line 170 of file gdiplusstringformat.h.

171  {
173  }
GpStringFormat * nativeFormat
#define INT
Definition: polytest.cpp:20
Status SetStatus(Status status) const
GpStatus WINGDIPAPI GdipSetStringFormatHotkeyPrefix(GpStringFormat *format, INT hkpx)
Definition: stringformat.c:264

◆ SetLineAlignment()

Status StringFormat::SetLineAlignment ( StringAlignment  align)
inline

Definition at line 176 of file gdiplusstringformat.h.

177  {
179  }
GpStringFormat * nativeFormat
int align(int length, int align)
Definition: dsound8.c:36
GpStatus WINGDIPAPI GdipSetStringFormatLineAlign(GpStringFormat *format, StringAlignment align)
Definition: stringformat.c:277
Status SetStatus(Status status) const

◆ SetMeasurableCharacterRanges()

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

Definition at line 182 of file gdiplusstringformat.h.

183  {
185  }
GpStatus WINGDIPAPI GdipSetStringFormatMeasurableCharacterRanges(GpStringFormat *format, INT rangeCount, GDIPCONST CharacterRange *ranges)
Definition: stringformat.c:290
GpStringFormat * nativeFormat
Status SetStatus(Status status) const

◆ SetStatus()

◆ SetTabStops()

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

Definition at line 188 of file gdiplusstringformat.h.

189  {
190  return SetStatus(DllExports::GdipSetStringFormatTabStops(nativeFormat, firstTabOffset, count, tabStops));
191  }
GpStringFormat * nativeFormat
GLuint GLuint GLsizei count
Definition: gl.h:1545
GpStatus WINGDIPAPI GdipSetStringFormatTabStops(GpStringFormat *format, REAL firsttab, INT count, GDIPCONST REAL *tabs)
Definition: stringformat.c:312
Status SetStatus(Status status) const

◆ SetTrimming()

Status StringFormat::SetTrimming ( StringTrimming  trimming)
inline

Definition at line 194 of file gdiplusstringformat.h.

195  {
197  }
GpStringFormat * nativeFormat
Status SetStatus(Status status) const
GpStatus WINGDIPAPI GdipSetStringFormatTrimming(GpStringFormat *format, StringTrimming trimming)
Definition: stringformat.c:344

Friends And Related Function Documentation

◆ getNat

GpStringFormat*& getNat ( const StringFormat sf)
friend

Definition at line 217 of file gdiplusstringformat.h.

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

Member Data Documentation

◆ lastStatus

Status StringFormat::lastStatus
mutableprotected

Definition at line 201 of file gdiplusstringformat.h.

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

◆ nativeFormat


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