Package wx :: Module richtext :: Class RichTextAttr

[frames | no frames]

## Type RichTextAttr

    object --+
             |
            RichTextAttr

The RichTextAttr class stored information about the various attributes for a block of text, including font, colour, indents, alignments, and etc.

Method Summary
RichTextAttr | ``__init__`(self, colText, colBack, alignment)` The RichTextAttr class stored information about the various attributes for a block of text, including font, colour, indents, alignments, and etc.
| `__del__(self)`
Font | `CreateFont(self)`
int | `GetAlignment(self)`
Colour | `GetBackgroundColour(self)`
String | `GetBulletFont(self)`
int | `GetBulletNumber(self)`
int | `GetBulletStyle(self)`
String | `GetBulletText(self)`
String | `GetCharacterStyleName(self)`
long | `GetFlags(self)`
| `GetFont(self)`
bool | `GetFontAttributes(self, font)`
String | `GetFontFaceName(self)`
int | `GetFontSize(self)`
int | `GetFontStyle(self)`
bool | `GetFontUnderlined(self)`
int | `GetFontWeight(self)`
long | `GetLeftIndent(self)`
long | `GetLeftSubIndent(self)`
int | `GetLineSpacing(self)`
int | `GetParagraphSpacingAfter(self)`
int | `GetParagraphSpacingBefore(self)`
String | `GetParagraphStyleName(self)`
long | `GetRightIndent(self)`
wxArrayInt | `GetTabs(self)`
Colour | `GetTextColour(self)`
bool | `HasAlignment(self)`
bool | `HasBackgroundColour(self)`
bool | `HasBulletNumber(self)`
bool | `HasBulletStyle(self)`
bool | `HasBulletText(self)`
bool | `HasCharacterStyleName(self)`
bool | `HasFlag(self, flag)`
bool | `HasFont(self)`
bool | `HasLeftIndent(self)`
bool | `HasLineSpacing(self)`
bool | `HasParagraphSpacingAfter(self)`
bool | `HasParagraphSpacingBefore(self)`
bool | `HasParagraphStyleName(self)`
bool | `HasRightIndent(self)`
bool | `HasTabs(self)`
bool | `HasTextColour(self)`
bool | `IsCharacterStyle(self)`
bool | `IsDefault(self)`
bool | `IsParagraphStyle(self)`
| `SetAlignment(self, alignment)`
| `SetBackgroundColour(self, colBack)`
| `SetBulletFont(self, bulletFont)`
| `SetBulletNumber(self, n)`
| `SetBulletStyle(self, style)`
| `SetBulletText(self, symbol)`
| `SetCharacterStyleName(self, name)`
| `SetFlags(self, flags)`
| `SetFont(self, font)`
| `SetFontFaceName(self, faceName)`
| `SetFontSize(self, pointSize)`
| `SetFontStyle(self, fontStyle)`
| `SetFontUnderlined(self, underlined)`
| `SetFontWeight(self, fontWeight)`
| `SetLeftIndent(self, indent, subIndent)`
| `SetLineSpacing(self, spacing)`
| `SetParagraphSpacingAfter(self, spacing)`
| `SetParagraphSpacingBefore(self, spacing)`
| `SetParagraphStyleName(self, name)`
| `SetRightIndent(self, indent)`
| `SetTabs(self, tabs)`
| `SetTextColour(self, colText)`

Property Summary
| `Alignment`: See `GetAlignment` and `SetAlignment`
| `BackgroundColour`: See `GetBackgroundColour` and `SetBackgroundColour`
| `BulletFont`: See `GetBulletFont` and `SetBulletFont`
| `BulletNumber`: See `GetBulletNumber` and `SetBulletNumber`
| `BulletStyle`: See `GetBulletStyle` and `SetBulletStyle`
| `BulletText`: See `GetBulletText` and `SetBulletText`
| `CharacterStyleName`: See `GetCharacterStyleName` and `SetCharacterStyleName`
| `Flags`: See `GetFlags` and `SetFlags`
| `Font`: See `GetFont` and `SetFont`
| `FontAttributes`: See `GetFontAttributes`
| `FontFaceName`: See `GetFontFaceName` and `SetFontFaceName`
| `FontSize`: See `GetFontSize` and `SetFontSize`
| `FontStyle`: See `GetFontStyle` and `SetFontStyle`
| `FontUnderlined`: See `GetFontUnderlined` and `SetFontUnderlined`
| `FontWeight`: See `GetFontWeight` and `SetFontWeight`
| `LeftIndent`: See `GetLeftIndent` and `SetLeftIndent`
| `LeftSubIndent`: See `GetLeftSubIndent`
| `LineSpacing`: See `GetLineSpacing` and `SetLineSpacing`
| `ParagraphSpacingAfter`: See `GetParagraphSpacingAfter` and `SetParagraphSpacingAfter`
| `ParagraphSpacingBefore`: See `GetParagraphSpacingBefore` and `SetParagraphSpacingBefore`
| `ParagraphStyleName`: See `GetParagraphStyleName` and `SetParagraphStyleName`
| `RightIndent`: See `GetRightIndent` and `SetRightIndent`
| `Tabs`: See `GetTabs` and `SetTabs`
| `TextColour`: See `GetTextColour` and `SetTextColour`
| `thisown`: The membership flag

Method Details

### __init__(self, colText=wxNullColour, colBack=wxNullColour, alignment=TEXT_ALIGNMENT_DEFAULT)
(Constructor)

The RichTextAttr class stored information about the various attributes for a block of text, including font, colour, indents, alignments, and etc.

  Parameters:
    `colText`
    (type=Colour)

    `colBack`
    (type=Colour)

    `alignment`
    (type=int)

  Returns:
    RichTextAttr
  Overrides:
    `__builtin__.object.__init__`

Property Details

### Alignment

See `GetAlignment` and `SetAlignment`

  Get Method:
    `GetAlignment`(self)
  Set Method:
    `SetAlignment`(self, alignment)

### BackgroundColour

See `GetBackgroundColour` and `SetBackgroundColour`

  Get Method:
    `GetBackgroundColour`(self)
  Set Method:
    `SetBackgroundColour`(self, colBack)

### BulletFont

See `GetBulletFont` and `SetBulletFont`

  Get Method:
    `GetBulletFont`(self)
  Set Method:
    `SetBulletFont`(self, bulletFont)

### BulletNumber

See `GetBulletNumber` and `SetBulletNumber`

  Get Method:
    `GetBulletNumber`(self)
  Set Method:
    `SetBulletNumber`(self, n)

### BulletStyle

See `GetBulletStyle` and `SetBulletStyle`

  Get Method:
    `GetBulletStyle`(self)
  Set Method:
    `SetBulletStyle`(self, style)

### BulletText

See `GetBulletText` and `SetBulletText`

  Get Method:
    `GetBulletText`(self)
  Set Method:
    `SetBulletText`(self, symbol)

### CharacterStyleName

See `GetCharacterStyleName` and `SetCharacterStyleName`

  Get Method:
    `GetCharacterStyleName`(self)
  Set Method:
    `SetCharacterStyleName`(self, name)

### Flags

See `GetFlags` and `SetFlags`

  Get Method:
    `GetFlags`(self)
  Set Method:
    `SetFlags`(self, flags)

### Font

See `GetFont` and `SetFont`

  Get Method:
    `GetFont`(self)
  Set Method:
    `SetFont`(self, font)

### FontAttributes

See `GetFontAttributes`

  Get Method:
    `GetFontAttributes`(self, font)

### FontFaceName

See `GetFontFaceName` and `SetFontFaceName`

  Get Method:
    `GetFontFaceName`(self)
  Set Method:
    `SetFontFaceName`(self, faceName)

### FontSize

See `GetFontSize` and `SetFontSize`

  Get Method:
    `GetFontSize`(self)
  Set Method:
    `SetFontSize`(self, pointSize)

### FontStyle

See `GetFontStyle` and `SetFontStyle`

  Get Method:
    `GetFontStyle`(self)
  Set Method:
    `SetFontStyle`(self, fontStyle)

### FontUnderlined

See `GetFontUnderlined` and `SetFontUnderlined`

  Get Method:
    `GetFontUnderlined`(self)
  Set Method:
    `SetFontUnderlined`(self, underlined)

### FontWeight

See `GetFontWeight` and `SetFontWeight`

  Get Method:
    `GetFontWeight`(self)
  Set Method:
    `SetFontWeight`(self, fontWeight)

### LeftIndent

See `GetLeftIndent` and `SetLeftIndent`

  Get Method:
    `GetLeftIndent`(self)
  Set Method:
    `SetLeftIndent`(self, indent, subIndent)

### LeftSubIndent

See `GetLeftSubIndent`

  Get Method:
    `GetLeftSubIndent`(self)

### LineSpacing

See `GetLineSpacing` and `SetLineSpacing`

  Get Method:
    `GetLineSpacing`(self)
  Set Method:
    `SetLineSpacing`(self, spacing)

### ParagraphSpacingAfter

See `GetParagraphSpacingAfter` and `SetParagraphSpacingAfter`

  Get Method:
    `GetParagraphSpacingAfter`(self)
  Set Method:
    `SetParagraphSpacingAfter`(self, spacing)

### ParagraphSpacingBefore

See `GetParagraphSpacingBefore` and `SetParagraphSpacingBefore`

  Get Method:
    `GetParagraphSpacingBefore`(self)
  Set Method:
    `SetParagraphSpacingBefore`(self, spacing)

### ParagraphStyleName

See `GetParagraphStyleName` and `SetParagraphStyleName`

  Get Method:
    `GetParagraphStyleName`(self)
  Set Method:
    `SetParagraphStyleName`(self, name)

### RightIndent

See `GetRightIndent` and `SetRightIndent`

  Get Method:
    `GetRightIndent`(self)
  Set Method:
    `SetRightIndent`(self, indent)

### Tabs

See `GetTabs` and `SetTabs`

  Get Method:
    `GetTabs`(self)
  Set Method:
    `SetTabs`(self, tabs)

### TextColour

See `GetTextColour` and `SetTextColour`

  Get Method:
    `GetTextColour`(self)
  Set Method:
    `SetTextColour`(self, colText)

### thisown

The membership flag

  Get Method:
    unknown--1272691796(...)
  Set Method:
    unknown--1272691740(...)

Generated by Epydoc 2.1.20050511.rpd on Thu Mar 22 12:07:08 2007 | http://epydoc.sf.net