docs/latex/wx/textattrex.tex

   1 \section{\class{wxTextAttrEx}}\label{wxtextattrex}
   2
   3 wxTextAttrEx is an extended version of wxTextAttr with more paragraph attributes.
   4 Currently it is only used with \helpref{wxRichTextCtrl}{wxrichtextctrl}.
   5
   6 It is intended that eventually, the members of wxTextAttrEx will
   7 be folded into wxTextAttr, and wxTextAttr will be the official
   8 cross-platform API for text controls that support attributes.
   9 However, for now, wxTextAttrEx is provided as a means of enabling
  10 extra functionality in wxRichTextCtrl, while retaining some compatibility
  11 with the wxTextAttr API.
  12
  13 The most efficient method of accessing wxRichTextCtrl functionality
  14 is a third attribute class, \helpref{wxRichTextAttr}{wxrichtextattr}, which
  15 optimizes its storage to allow it to be used for implementing objects
  16 in a buffer, as well as access to that buffer.
  17
  18 This section only documents the additional members; see \helpref{wxTextAttr}{wxtextattr} for
  19 the remaining functions.
  20
  21 \wxheading{Derived from}
  22
  23 \helpref{wxTextAttr}{wxtextattr}
  24
  25 \wxheading{Include files}
  26
  27 <wx/richtext/richtextbuffer.h>
  28
  29 \wxheading{Library}
  30
  31 \helpref{wxRichtext}{librarieslist}
  32
  33 \wxheading{Constants}
  34
  35 The following values can be passed to SetAlignment to determine
  36 paragraph alignment.
  37
  38 {\small
  39 \begin{verbatim}
  40 enum wxTextAttrAlignment
  41 {
  42     wxTEXT_ALIGNMENT_DEFAULT,
  43     wxTEXT_ALIGNMENT_LEFT,
  44     wxTEXT_ALIGNMENT_CENTRE,
  45     wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE,
  46     wxTEXT_ALIGNMENT_RIGHT,
  47     wxTEXT_ALIGNMENT_JUSTIFIED
  48 };
  49 \end{verbatim}
  50 }
  51
  52 These values are passed in a bitlist to SetFlags to determine
  53 what attributes will be considered when setting the attributes
  54 for a text control.
  55
  56 {\small
  57 \begin{verbatim}
  58 // Standard wxTextAttr constants
  59
  60 #define wxTEXT_ATTR_TEXT_COLOUR             0x0001
  61 #define wxTEXT_ATTR_BACKGROUND_COLOUR       0x0002
  62 #define wxTEXT_ATTR_FONT_FACE               0x0004
  63 #define wxTEXT_ATTR_FONT_SIZE               0x0008
  64 #define wxTEXT_ATTR_FONT_WEIGHT             0x0010
  65 #define wxTEXT_ATTR_FONT_ITALIC             0x0020
  66 #define wxTEXT_ATTR_FONT_UNDERLINE          0x0040
  67 #define wxTEXT_ATTR_FONT \
  68   wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT \
  69 | wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE
  70 #define wxTEXT_ATTR_ALIGNMENT               0x0080
  71 #define wxTEXT_ATTR_LEFT_INDENT             0x0100
  72 #define wxTEXT_ATTR_RIGHT_INDENT            0x0200
  73 #define wxTEXT_ATTR_TABS                    0x0400
  74
  75 // Extra formatting flags not in wxTextAttr
  76
  77 #define wxTEXT_ATTR_PARA_SPACING_AFTER      0x00000800
  78 #define wxTEXT_ATTR_PARA_SPACING_BEFORE     0x00001000
  79 #define wxTEXT_ATTR_LINE_SPACING            0x00002000
  80 #define wxTEXT_ATTR_CHARACTER_STYLE_NAME    0x00004000
  81 #define wxTEXT_ATTR_PARAGRAPH_STYLE_NAME    0x00008000
  82 #define wxTEXT_ATTR_LIST_STYLE_NAME         0x00010000
  83 #define wxTEXT_ATTR_BULLET_STYLE            0x00020000
  84 #define wxTEXT_ATTR_BULLET_NUMBER           0x00040000
  85 #define wxTEXT_ATTR_BULLET_TEXT             0x00080000
  86 #define wxTEXT_ATTR_BULLET_NAME             0x00100000
  87 #define wxTEXT_ATTR_URL                     0x00200000
  88 #define wxTEXT_ATTR_PAGE_BREAK              0x00400000
  89 #define wxTEXT_ATTR_EFFECTS                 0x00800000
  90 #define wxTEXT_ATTR_OUTLINE_LEVEL           0x01000000
  91 \end{verbatim}
  92 }
  93
  94 The following styles can be passed to wxTextAttrEx::SetBulletStyle:
  95
  96 {\small
  97 \begin{verbatim}
  98 #define wxTEXT_ATTR_BULLET_STYLE_NONE               0x00000000
  99 #define wxTEXT_ATTR_BULLET_STYLE_ARABIC             0x00000001
 100 #define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER      0x00000002
 101 #define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER      0x00000004
 102 #define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER        0x00000008
 103 #define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER        0x00000010
 104 #define wxTEXT_ATTR_BULLET_STYLE_SYMBOL             0x00000020
 105 #define wxTEXT_ATTR_BULLET_STYLE_BITMAP             0x00000040
 106 #define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES        0x00000080
 107 #define wxTEXT_ATTR_BULLET_STYLE_PERIOD             0x00000100
 108 #define wxTEXT_ATTR_BULLET_STYLE_STANDARD           0x00000200
 109 #define wxTEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS  0x00000400
 110 #define wxTEXT_ATTR_BULLET_STYLE_OUTLINE            0x00000800
 111 #define wxTEXT_ATTR_BULLET_STYLE_ALIGN_LEFT         0x00000000
 112 #define wxTEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT        0x00001000
 113 #define wxTEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE       0x00002000
 114 \end{verbatim}
 115 }
 116
 117 Of these, wxTEXT\_ATTR\_BULLET\_STYLE\_BITMAP is unimplemented.
 118
 119 The following constants can be passed to wxTextAttrEx::SetLineSpacing:
 120
 121 {\small
 122 \begin{verbatim}
 123 #define wxTEXT_ATTR_LINE_SPACING_NORMAL         10
 124 #define wxTEXT_ATTR_LINE_SPACING_HALF           15
 125 #define wxTEXT_ATTR_LINE_SPACING_TWICE          20
 126 \end{verbatim}
 127 }
 128
 129 The following styles can be passed to wxTextAttrEx::SetTextEffects:
 130
 131 {\small
 132 \begin{verbatim}
 133 #define wxTEXT_ATTR_EFFECT_NONE                     0x00000000
 134 #define wxTEXT_ATTR_EFFECT_CAPITALS                 0x00000001
 135 #define wxTEXT_ATTR_EFFECT_SMALL_CAPITALS           0x00000002
 136 #define wxTEXT_ATTR_EFFECT_STRIKETHROUGH            0x00000004
 137 #define wxTEXT_ATTR_EFFECT_DOUBLE_STRIKETHROUGH     0x00000008
 138 #define wxTEXT_ATTR_EFFECT_SHADOW                   0x00000010
 139 #define wxTEXT_ATTR_EFFECT_EMBOSS                   0x00000020
 140 #define wxTEXT_ATTR_EFFECT_OUTLINE                  0x00000040
 141 #define wxTEXT_ATTR_EFFECT_ENGRAVE                  0x00000080
 142 #define wxTEXT_ATTR_EFFECT_SUPERSCRIPT              0x00000100
 143 #define wxTEXT_ATTR_EFFECT_SUBSCRIPT                0x00000200
 144 \end{verbatim}
 145 }
 146
 147 Of these, only wxTEXT\_ATTR\_EFFECT\_CAPITALS and wxTEXT\_ATTR\_EFFECT\_STRIKETHROUGH are implemented.
 148
 149 \wxheading{See also}
 150
 151 \helpref{wxTextAttr}{wxtextattr}, \helpref{wxRichTextAttr}{wxrichtextattr}, \helpref{wxRichTextCtrl}{wxrichtextctrl}
 152
 153 \latexignore{\rtfignore{\wxheading{Members}}}
 154
 155
 156 \membersection{wxTextAttrEx::wxTextAttrEx}\label{wxtextattrexwxtextattrex}
 157
 158 \func{}{wxTextAttrEx}{\void}
 159
 160
 161 \func{}{wxTextAttrEx}{\param{const wxTextAttrEx\& }{attr}}
 162
 163 Constructors.
 164
 165 \membersection{wxTextAttrEx::GetBulletFont}\label{wxtextattrexgetbulletfont}
 166
 167 \constfunc{const wxString\&}{GetBulletFont}{\void}
 168
 169 Returns a string containing the name of the font associated with the bullet symbol.
 170 Only valid for attributes with wxTEXT\_ATTR\_BULLET\_SYMBOL.
 171
 172 \membersection{wxTextAttrEx::GetBulletName}\label{wxtextattrexgetbulletname}
 173
 174 \constfunc{const wxString\&}{GetBulletName}{\void}
 175
 176 Returns the standard bullet name, applicable if the bullet style is wxTEXT\_ATTR\_BULLET\_STYLE\_STANDARD.
 177 Currently the following standard bullet names are supported:
 178
 179 \begin{itemize}\itemsep=0pt
 180 \item {\tt standard/circle}
 181 \item {\tt standard/square}
 182 \item {\tt standard/diamond}
 183 \item {\tt standard/triangle}
 184 \end{itemize}
 185
 186 If you wish your application to support further bullet graphics, you can derive a
 187 class from wxRichTextRenderer or wxRichTextStdRenderer, override {\tt DrawStandardBullet} and {\tt EnumerateStandardBulletNames}, and
 188 set an instance of the class using \helpref{wxRichTextBuffer::SetRenderer}{wxrichtextbuffersetrenderer}.
 189
 190 \membersection{wxTextAttrEx::GetBulletNumber}\label{wxtextattrexgetbulletnumber}
 191
 192 \constfunc{int}{GetBulletNumber}{\void}
 193
 194 Returns the bullet number.
 195
 196 \membersection{wxTextAttrEx::GetBulletStyle}\label{wxtextattrexgetbulletstyle}
 197
 198 \constfunc{int}{GetBulletStyle}{\void}
 199
 200 Returns the bullet style.
 201 See \helpref{wxTextAttrEx::SetBulletStyle}{wxtextattrexsetbulletstyle} for a list of available styles.
 202
 203 \membersection{wxTextAttrEx::GetBulletText}\label{wxtextattrexgetbullettext}
 204
 205 \constfunc{const wxString\&}{GetBulletText}{\void}
 206
 207 Returns the bullet text, which could be a symbol, or (for example) cached outline text.
 208
 209 \membersection{wxTextAttrEx::GetCharacterStyleName}\label{wxtextattrexgetcharacterstylename}
 210
 211 \constfunc{const wxString\&}{GetCharacterStyleName}{\void}
 212
 213 Returns the name of the character style.
 214
 215 \membersection{wxTextAttrEx::GetLineSpacing}\label{wxtextattrexgetlinespacing}
 216
 217 \constfunc{int}{GetLineSpacing}{\void}
 218
 219 Returns the line spacing value, one of wxTEXT\_ATTR\_LINE\_SPACING\_NORMAL,
 220 wxTEXT\_ATTR\_LINE\_SPACING\_HALF, and wxTEXT\_ATTR\_LINE\_SPACING\_TWICE.
 221
 222 \membersection{wxTextAttrEx::GetListStyleName}\label{wxtextattrexgetliststylename}
 223
 224 \constfunc{const wxString\&}{GetListStyleName}{\void}
 225
 226 Returns the name of the list style.
 227
 228 \membersection{wxTextAttrEx::GetOutlineLevel}\label{wxtextattrexgetoutlinelevel}
 229
 230 \constfunc{bool}{GetOutlineLevel}{\void}
 231
 232 Returns the outline level.
 233
 234 \membersection{wxTextAttrEx::GetParagraphSpacingAfter}\label{wxtextattrexgetparagraphspacingafter}
 235
 236 \constfunc{int}{GetParagraphSpacingAfter}{\void}
 237
 238 Returns the space in tenths of a millimeter after the paragraph.
 239
 240 \membersection{wxTextAttrEx::GetParagraphSpacingBefore}\label{wxtextattrexgetparagraphspacingbefore}
 241
 242 \constfunc{int}{GetParagraphSpacingBefore}{\void}
 243
 244 Returns the space in tenths of a millimeter before the paragraph.
 245
 246 \membersection{wxTextAttrEx::GetParagraphStyleName}\label{wxtextattrexgetparagraphstylename}
 247
 248 \constfunc{const wxString\&}{GetParagraphStyleName}{\void}
 249
 250 Returns the name of the paragraph style.
 251
 252 \membersection{wxTextAttrEx::GetTextEffectFlags}\label{wxtextattrexgettexteffectflags}
 253
 254 \constfunc{int}{GetTextEffectFlags}{\void}
 255
 256 Returns the text effect bits of interest. See \helpref{wxTextAttr::SetFlags}{wxtextattrsetflags} for further information.
 257
 258 \membersection{wxTextAttrEx::GetTextEffects}\label{wxtextattrexgettexteffects}
 259
 260 \constfunc{int}{GetTextEffects}{\void}
 261
 262 Returns the text effects, a bit list of styles. See \helpref{wxTextAttrEx::SetTextEffects}{wxtextattrexsettexteffects} for
 263 details.
 264
 265 \membersection{wxTextAttrEx::GetURL}\label{wxtextattrexgeturl}
 266
 267 \constfunc{const wxString\&}{GetURL}{\void}
 268
 269 Returns the URL for the content. Content with wxTEXT\_ATTR\_URL style
 270 causes wxRichTextCtrl to show a hand cursor over it, and wxRichTextCtrl generates
 271 a wxTextUrlEvent when the content is clicked.
 272
 273 \membersection{wxTextAttrEx::HasBulletName}\label{wxtextattrexhasbulletname}
 274
 275 \constfunc{bool}{HasBulletName}{\void}
 276
 277 Returns \true if the attribute object specifies a standard bullet name.
 278
 279 \membersection{wxTextAttrEx::HasBulletNumber}\label{wxtextattrexhasbulletnumber}
 280
 281 \constfunc{bool}{HasBulletNumber}{\void}
 282
 283 Returns \true if the attribute object specifies a bullet number.
 284
 285 \membersection{wxTextAttrEx::HasBulletStyle}\label{wxtextattrexhasbulletstyle}
 286
 287 \constfunc{bool}{HasBulletStyle}{\void}
 288
 289 Returns \true if the attribute object specifies a bullet style.
 290
 291 \membersection{wxTextAttrEx::HasBulletText}\label{wxtextattrexhasbullettext}
 292
 293 \constfunc{bool}{HasBulletText}{\void}
 294
 295 Returns \true if the attribute object specifies bullet text (usually containing a symbol).
 296
 297 \membersection{wxTextAttrEx::HasCharacterStyleName}\label{wxtextattrexhascharacterstylename}
 298
 299 \constfunc{bool}{HasCharacterStyleName}{\void}
 300
 301 Returns \true if the attribute object specifies a character style name.
 302
 303 \membersection{wxTextAttrEx::HasLineSpacing}\label{wxtextattrexhaslinespacing}
 304
 305 \constfunc{bool}{HasLineSpacing}{\void}
 306
 307 Returns \true if the attribute object specifies line spacing.
 308
 309 \membersection{wxTextAttrEx::HasListStyleName}\label{wxtextattrexhasliststylename}
 310
 311 \constfunc{bool}{HasListStyleName}{\void}
 312
 313 Returns \true if the attribute object specifies a list style name.
 314
 315 \membersection{wxTextAttrEx::HasOutlineLevel}\label{wxtextattrexhasoutlinelevel}
 316
 317 \constfunc{bool}{HasOutlineLevel}{\void}
 318
 319 Returns \true if the attribute object specifies an outline level.
 320
 321 \membersection{wxTextAttrEx::HasPageBreak}\label{wxtextattrexhaspagebreak}
 322
 323 \constfunc{bool}{HasPageBreak}{\void}
 324
 325 Returns \true if the attribute object specifies a page break before this paragraph.
 326
 327 \membersection{wxTextAttrEx::HasParagraphSpacingAfter}\label{wxtextattrexhasparagraphspacingafter}
 328
 329 \constfunc{bool}{HasParagraphSpacingAfter}{\void}
 330
 331 Returns \true if the attribute object specifies spacing after a paragraph.
 332
 333 \membersection{wxTextAttrEx::HasParagraphSpacingBefore}\label{wxtextattrexhasparagraphspacingbefore}
 334
 335 \constfunc{bool}{HasParagraphSpacingBefore}{\void}
 336
 337 Returns \true if the attribute object specifies spacing before a paragraph.
 338
 339 \membersection{wxTextAttrEx::HasParagraphStyleName}\label{wxtextattrexhasparagraphstylename}
 340
 341 \constfunc{bool}{HasParagraphStyleName}{\void}
 342
 343 Returns \true if the attribute object specifies a paragraph style name.
 344
 345 \membersection{wxTextAttrEx::HasTextEffects}\label{wxtextattrexhastexteffects}
 346
 347 \constfunc{bool}{HasTextEffects}{\void}
 348
 349 Returns \true if the attribute object specifies text effects.
 350
 351 \membersection{wxTextAttrEx::HasURL}\label{wxtextattrexhasurl}
 352
 353 \constfunc{bool}{HasURL}{\void}
 354
 355 Returns \true if the attribute object specifies a URL.
 356
 357 \membersection{wxTextAttrEx::Init}\label{wxtextattrexinit}
 358
 359 \func{void}{Init}{\void}
 360
 361 Initialises this object.
 362
 363 \membersection{wxTextAttrEx::IsCharacterStyle}\label{wxtextattrexischaracterstyle}
 364
 365 \constfunc{bool}{IsCharacterStyle}{\void}
 366
 367 Returns \true if the object represents a character style, that is,
 368 the flags specify a font or a text background or foreground colour.
 369
 370 \membersection{wxTextAttrEx::IsDefault}\label{wxtextattrexisdefault}
 371
 372 \constfunc{bool}{IsDefault}{\void}
 373
 374 Returns \false if we have any attributes set, \true otherwise.
 375
 376 \membersection{wxTextAttrEx::IsParagraphStyle}\label{wxtextattrexisparagraphstyle}
 377
 378 \constfunc{bool}{IsParagraphStyle}{\void}
 379
 380 Returns \true if the object represents a paragraph style, that is,
 381 the flags specify alignment, indentation, tabs, paragraph spacing, or
 382 bullet style.
 383
 384 \membersection{wxTextAttrEx::SetBulletFont}\label{wxtextattrexsetbulletfont}
 385
 386 \func{void}{SetBulletFont}{\param{const wxString\& }{font}}
 387
 388 Sets the name of the font associated with the bullet symbol.
 389 Only valid for attributes with wxTEXT\_ATTR\_BULLET\_SYMBOL.
 390
 391 \membersection{wxTextAttrEx::SetBulletNumber}\label{wxtextattrexsetbulletnumber}
 392
 393 \func{void}{SetBulletNumber}{\param{int }{n}}
 394
 395 Sets the bullet number.
 396
 397 \membersection{wxTextAttrEx::SetBulletName}\label{wxtextattrexsetbulletname}
 398
 399 \func{void}{SetBulletName}{\param{const wxString\& }{name}}
 400
 401 Sets the standard bullet name, applicable if the bullet style is wxTEXT\_ATTR\_BULLET\_STYLE\_STANDARD.
 402 See \helpref{wxTextAttrEx::GetBulletName}{wxtextattrexgetbulletname} for a list
 403 of supported names, and how to expand the range of supported types.
 404
 405 \membersection{wxTextAttrEx::SetBulletStyle}\label{wxtextattrexsetbulletstyle}
 406
 407 \func{void}{SetBulletStyle}{\param{int }{style}}
 408
 409 Sets the bullet style. The following styles can be passed:
 410
 411 {\small
 412 \begin{verbatim}
 413 #define wxTEXT_ATTR_BULLET_STYLE_NONE               0x00000000
 414 #define wxTEXT_ATTR_BULLET_STYLE_ARABIC             0x00000001
 415 #define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER      0x00000002
 416 #define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER      0x00000004
 417 #define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER        0x00000008
 418 #define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER        0x00000010
 419 #define wxTEXT_ATTR_BULLET_STYLE_SYMBOL             0x00000020
 420 #define wxTEXT_ATTR_BULLET_STYLE_BITMAP             0x00000040
 421 #define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES        0x00000080
 422 #define wxTEXT_ATTR_BULLET_STYLE_PERIOD             0x00000100
 423 #define wxTEXT_ATTR_BULLET_STYLE_STANDARD           0x00000200
 424 #define wxTEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS  0x00000400
 425 #define wxTEXT_ATTR_BULLET_STYLE_OUTLINE            0x00000800
 426 #define wxTEXT_ATTR_BULLET_STYLE_ALIGN_LEFT         0x00000000
 427 #define wxTEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT        0x00001000
 428 #define wxTEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE       0x00002000
 429 \end{verbatim}
 430 }
 431
 432 Currently wxTEXT\_ATTR\_BULLET\_STYLE\_BITMAP is not supported.
 433
 434 \membersection{wxTextAttrEx::SetBulletText}\label{wxtextattrexsetbullettext}
 435
 436 \func{void}{SetBulletText}{\param{const wxString\& }{text}}
 437
 438 Sets the bullet text, which could be a symbol, or (for example) cached outline text.
 439
 440 \membersection{wxTextAttrEx::SetCharacterStyleName}\label{wxtextattrexsetcharacterstylename}
 441
 442 \func{void}{SetCharacterStyleName}{\param{const wxString\& }{name}}
 443
 444 Sets the character style name.
 445
 446 \membersection{wxTextAttrEx::SetLineSpacing}\label{wxtextattrexsetlinespacing}
 447
 448 \func{void}{SetLineSpacing}{\param{int }{spacing}}
 449
 450 Sets the line spacing. {\it spacing} is a multiple, where 10 means single-spacing,
 451 15 means 1.5 spacing, and 20 means double spacing. The following constants are
 452 defined for convenience:
 453
 454 {\small
 455 \begin{verbatim}
 456 #define wxTEXT_ATTR_LINE_SPACING_NORMAL         10
 457 #define wxTEXT_ATTR_LINE_SPACING_HALF           15
 458 #define wxTEXT_ATTR_LINE_SPACING_TWICE          20
 459 \end{verbatim}
 460 }
 461
 462 \membersection{wxTextAttrEx::SetListStyleName}\label{wxtextattrexsetliststylename}
 463
 464 \func{void}{SetListStyleName}{\param{const wxString\& }{name}}
 465
 466 Sets the list style name.
 467
 468 \membersection{wxTextAttrEx::SetOutlineLevel}\label{wxtextattrexsetoutlinelevel}
 469
 470 \func{void}{SetOutlineLevel}{\param{int}{ level}}
 471
 472 Specifies the outline level. Zero represents normal text. At present, the outline level is
 473 not used, but may be used in future for determining list levels and for applications
 474 that need to store document structure information.
 475
 476 \membersection{wxTextAttrEx::SetPageBreak}\label{wxtextattrexsetpagebreak}
 477
 478 \func{void}{SetPageBreak}{\param{bool}{ pageBreak = true}}
 479
 480 Specifies a page break before this paragraph.
 481
 482 \membersection{wxTextAttrEx::SetParagraphSpacingAfter}\label{wxtextattrexsetparagraphspacingafter}
 483
 484 \func{void}{SetParagraphSpacingAfter}{\param{int }{spacing}}
 485
 486 Sets the spacing after a paragraph, in tenths of a millimetre.
 487
 488 \membersection{wxTextAttrEx::SetParagraphSpacingBefore}\label{wxtextattrexsetparagraphspacingbefore}
 489
 490 \func{void}{SetParagraphSpacingBefore}{\param{int }{spacing}}
 491
 492 Sets the spacing before a paragraph, in tenths of a millimetre.
 493
 494 \membersection{wxTextAttrEx::SetParagraphStyleName}\label{wxtextattrexsetparagraphstylename}
 495
 496 \func{void}{SetParagraphStyleName}{\param{const wxString\& }{name}}
 497
 498 Sets the name of the paragraph style.
 499
 500 \membersection{wxTextAttrEx::SetTextEffectFlags}\label{wxtextattrexsettexteffectflags}
 501
 502 \func{void}{SetTextEffectFlags}{\param{int }{flags}}
 503
 504 Sets the text effect bits of interest. You should also pass wxTEXT\_ATTR\_EFFECTS to \helpref{wxTextAttr::SetFlags}{wxtextattrsetflags}.
 505
 506 \membersection{wxTextAttrEx::SetTextEffects}\label{wxtextattrexsettexteffects}
 507
 508 \func{void}{SetTextEffects}{\param{int }{effects}}
 509
 510 Sets the text effects, a bit list of styles.
 511
 512 The following styles can be passed:
 513
 514 {\small
 515 \begin{verbatim}
 516 #define wxTEXT_ATTR_EFFECT_NONE                     0x00000000
 517 #define wxTEXT_ATTR_EFFECT_CAPITALS                 0x00000001
 518 #define wxTEXT_ATTR_EFFECT_SMALL_CAPITALS           0x00000002
 519 #define wxTEXT_ATTR_EFFECT_STRIKETHROUGH            0x00000004
 520 #define wxTEXT_ATTR_EFFECT_DOUBLE_STRIKETHROUGH     0x00000008
 521 #define wxTEXT_ATTR_EFFECT_SHADOW                   0x00000010
 522 #define wxTEXT_ATTR_EFFECT_EMBOSS                   0x00000020
 523 #define wxTEXT_ATTR_EFFECT_OUTLINE                  0x00000040
 524 #define wxTEXT_ATTR_EFFECT_ENGRAVE                  0x00000080
 525 #define wxTEXT_ATTR_EFFECT_SUPERSCRIPT              0x00000100
 526 #define wxTEXT_ATTR_EFFECT_SUBSCRIPT                0x00000200
 527 \end{verbatim}
 528 }
 529
 530 Of these, only wxTEXT\_ATTR\_EFFECT\_CAPITALS and wxTEXT\_ATTR\_EFFECT\_STRIKETHROUGH are implemented.
 531 wxTEXT\_ATTR\_EFFECT\_CAPITALS capitalises text when displayed (leaving the case of the actual buffer
 532 text unchanged), and wxTEXT\_ATTR\_EFFECT\_STRIKETHROUGH draws a line through text.
 533
 534 To set effects, you should also pass wxTEXT\_ATTR\_EFFECTS to \helpref{wxTextAttr::SetFlags}{wxtextattrsetflags}, and call\rtfsp
 535 \helpref{wxTextAttrEx::SetTextEffectFlags}{wxtextattrexsettexteffectflags} with the styles (taken from the
 536 above set) that you are interested in setting.
 537
 538 \membersection{wxTextAttrEx::SetURL}\label{wxtextattrexseturl}
 539
 540 \func{void}{SetURL}{\param{const wxString\& }{url}}
 541
 542 Sets the URL for the content. Sets the wxTEXT\_ATTR\_URL style; content with this style
 543 causes wxRichTextCtrl to show a hand cursor over it, and wxRichTextCtrl generates
 544 a wxTextUrlEvent when the content is clicked.
 545
 546 \membersection{wxTextAttrEx::operator=}\label{wxtextattrexoperatorassign}
 547
 548 \func{void operator}{operator=}{\param{const wxTextAttr\& }{attr}}
 549
 550 Assignment from a wxTextAttr object.
 551
 552 \func{void operator}{operator=}{\param{const wxTextAttrEx\& }{attr}}
 553
 554 Assignment from a wxTextAttrEx object.
 555