This class represents the whole buffer associated with a RichTextCtrl.
RichTextParagraphLayoutBox
TextAttr, RichTextAttr, RichTextCtrl
Copy constructor.
destructor()Destructor.
Adds an event handler to the buffer’s list of handlers. A buffer associated with
a contol has the control as the only event handler, but the application is free
to add more if further notification is required. All handlers are notified
of an event originating from the buffer, such as the replacement of a style sheet
during loading. The buffer never deletes any of the event handlers, unless
RichTextBuffer#remove_event_handler is
called with as the second argument.
Adds a file handler.
Adds a paragraph of text.
Returns if the buffer is currently collapsing commands into a single notional command.
Begins using alignment.
Begins collapsing undo/redo commands. Note that this may not work properly
if combining commands that delete or insert content, changing ranges for
subsequent actions.
cmdName should be the name of the combined command that will appear
next to Undo and Redo in the edit menu.
Begin applying bold.
Begins applying the named character style.
Begins using this font.
Begins using the given point size.
Begins using italic.
Begin using leftIndent for the left indent, and optionally leftSubIndent for
the sub-indent. Both are expressed in tenths of a millimetre.
The sub-indent is an offset from the left of the paragraph, and is used for all but the
first line in a paragraph. A positive value will cause the first line to appear to the left
of the subsequent lines, and a negative value will cause the first line to be indented
relative to the subsequent lines.
Begins line spacing using the specified value. spacing is a multiple, where 10 means single-spacing,
15 means 1.5 spacing, and 20 means double spacing. The following constants are
defined for convenience:
Begins using a specified list style. Optionally, you can also pass a level and a number.
Begins a numbered bullet. This call will be needed for each item in the list, and the
application should take care of incrementing the numbering.
bulletNumber is a number, usually starting with 1.
leftIndent and leftSubIndent are values in tenths of a millimetre.
bulletStyle is a bitlist of the following values:
#define TEXT_ATTR_BULLET_STYLE_NONE 0×00000000 #define TEXT_ATTR_BULLET_STYLE_ARABIC 0×00000001 #define TEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0×00000002 #define TEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0×00000004 #define TEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0×00000008 #define TEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0×00000010 #define TEXT_ATTR_BULLET_STYLE_SYMBOL 0×00000020 #define TEXT_ATTR_BULLET_STYLE_BITMAP 0×00000040 #define TEXT_ATTR_BULLET_STYLE_PARENTHESES 0×00000080 #define TEXT_ATTR_BULLET_STYLE_PERIOD 0×00000100 #define TEXT_ATTR_BULLET_STYLE_STANDARD 0×00000200 #define TEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS 0×00000400 #define TEXT_ATTR_BULLET_STYLE_OUTLINE 0×00000800 #define TEXT_ATTR_BULLET_STYLE_ALIGN_LEFT 0×00000000 #define TEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT 0×00001000 #define TEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE 0×00002000RichTextBuffer uses indentation to render a bulleted item. The left indent is the distance between
the margin and the bullet. The content of the paragraph, including the first line, starts
at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the
left of the actual paragraph is leftSubIndent.
Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of
a millimetre.
Begins applying the named paragraph style.
Begins a right indent, specified in tenths of a millimetre.
Begins using a specified style.
Begins suppressing undo/redo commands. The way undo is suppressed may be implemented
differently by each command. If not dealt with by a command implementation, then
it will be implemented automatically by not storing the command in the undo history
when the action is submitted to the command processor.
Begins applying a standard bullet, using one of the standard bullet names (currently standard/circle
or standard/square
.
See begin_numbered_bullet for an explanation of how indentation is used to render the bulleted paragraph.
Begins applying a symbol bullet, using a character from the current font. See begin_numbered_bullet for
an explanation of how indentation is used to render the bulleted paragraph.
Begins using the specified text foreground colour.
Begins using underline.
Begins applying TEXT_ATTR_URL to the content. Pass a URL and optionally, a character style to apply,
since it is common to mark a URL with a familiar style such as blue text with underlining.
Returns if content can be pasted from the clipboard.
Cleans up the file handlers.
Clears the buffer.
Clears the list style from the given range, clearing list-related attributes and applying any named paragraph style associated with each paragraph.
flags is a bit list of the following:
See also RichTextBuffer#set_list_style, RichTextBuffer#promote_list, RichTextBuffer#number_list.
Clears the style stack.
Clones the object.
Copies the given buffer.
Copy the given range to the clipboard.
Submits a command to delete the given range.
Dumps the contents of the buffer for debugging purposes.
Ends alignment.
Ends all styles that have been started with a Begin… command.
Ends collapsing undo/redo commands, and submits the combined command.
Ends using bold.
Ends using the named character style.
Ends using a font.
Ends using a point size.
Ends using italic.
Ends using a left indent.
Ends using a line spacing.
Ends using a specified list style.
Ends a numbered bullet.
Ends paragraph spacing.
Ends applying a named character style.
Ends using a right indent.
Ends the current style.
Ends suppressing undo/redo commands.
Ends using a symbol bullet.
Ends using a standard bullet.
Ends using a text foreground colour.
Ends using underline.
Ends applying a URL.
Finds a handler by type.
RichTextFileHandler find_handler(%(arg-type)String% extension, Integer imageType)Finds a handler by extension and type.
RichTextFileHandler find_handler(%(arg-type)String% name)Finds a handler by name.
Finds a handler by filename or, if supplied, type.
Gets the basic (overall) style. This is the style of the whole buffer
before further styles are applied, unlike the default style, which only
affects the style currently being applied (for example, setting the
default style to bold will cause subsequently inserted text to be bold).
Gets the collapsed command.
Gets the command processor. A text buffer always creates its own command processor when it is
initialized.
Returns the current default style, affecting the style currently being applied (for example, setting the default
style to bold will cause subsequently inserted text to be bold).
Gets a wildcard incorporating all visible handlers. If types is present,
it will be filled with the file type corresponding to each filter. This can be
used to determine the type to pass to load_file given a selected filter.
Returns the list of file handlers.
Returns the object to be used to render certain aspects of the content, such as bullets.
Gets the attributes at the given position.
This function gets the combined style – that is, the style you see on the screen as a result
of combining base style, paragraph style and character style attributes. To get the character
or paragraph style alone, use get_uncombined_style.
This function gets a style representing the common, combined attributes
in the given range. Attributes which have different values within the
specified range will not be included the style flags.
The function is used to get the attributes to display in the formatting
dialog: the user can edit the attributes common to the selection, and
optionally specify the values of further attributes to be applied
uniformly.
To apply the edited attributes, you can use set_style specifying
the RICHTEXT_SETSTYLE_OPTIMIZE flag, which will only apply attributes that are different
from the combined attributes within the range. So, the user edits the effective, displayed attributes
for the range, but his choice won’t be applied unnecessarily to content. As an example,
say the style for a paragraph specifies bold, but the paragraph text doesn’t specify a weight. The
combined style is bold, and this is what the user will see on-screen and in the formatting
dialog. The user now specifies red text, in addition to bold. When applying with
SetStyle, the content font weight attributes won’t be changed to bold because this is already specified
by the paragraph. However the text colour attributes will be changed to
show red.
Returns the current style sheet associated with the buffer, if any.
Get the size of the style stack, for example to check correct nesting.
Gets the attributes at the given position.
This function gets the uncombined style – that is, the attributes associated with the
paragraph or character content, and not necessarily the combined attributes you see on the
screen. To get the combined attributes, use get_style.
If you specify (any) paragraph attribute in _style_’s flags, this function will fetch
the paragraph attributes. Otherwise, it will return the character attributes.
Finds the text position for the given position, putting the position in textPosition if
one is found. pt is in logical units (a zero y position is
at the beginning of the buffer).
The function returns one of the following values:
// The point was not on this object #define RICHTEXT_HITTEST_NONE 0×01 // The point was before the position returned from HitTest #define RICHTEXT_HITTEST_BEFORE 0×02 // The point was after the position returned from HitTest #define RICHTEXT_HITTEST_AFTER 0×04 // The point was on the position returned from HitTest #define RICHTEXT_HITTEST_ON 0×08 // The point was on space outside content #define RICHTEXT_HITTEST_OUTSIDE 0×10Initialisation.
Initialises the standard handlers. Currently, only the plain text loading/saving handler
is initialised by default.
Inserts a handler at the front of the list.
Submits a command to insert the given image.
Submits a command to insert a newline.
Submits a command to insert the given text.
Returns if the buffer has been modified.
Loads content from a stream.
Boolean load_file(%(arg-type)String% filename, Integer type = RICHTEXT_TYPE_ANY)Loads content from a file.
Marks the buffer as modified or unmodified.
Numbers the paragraphs in the given range. Pass flags to determine how the attributes are set.
Either the style definition or the name of the style definition (in the current sheet) can be passed.
flags is a bit list of the following:
See also RichTextBuffer#set_list_style, RichTextBuffer#promote_list, RichTextBuffer#clear_list_style.
Pastes the clipboard content to the buffer at the given position.
Promotes or demotes the paragraphs in the given range. A positive promoteBy produces a smaller indent, and a negative number
produces a larger indent. Pass flags to determine how the attributes are set.
Either the style definition or the name of the style definition (in the current sheet) can be passed.
flags is a bit list of the following:
See also RichTextBuffer#set_list_style, See also RichTextBuffer#set_list_style, RichTextBuffer#clear_list_style.
Removes an event handler from the buffer’s list of handlers, deleting the object if deleteHandler is .
Removes a handler.
Clears the buffer, adds a new blank paragraph, and clears the command history.
Saves content to a stream.
Boolean save_file(%(arg-type)String% filename, Integer type = RICHTEXT_TYPE_ANY)Saves content to a file.
Sets the basic (overall) style. This is the style of the whole
buffer before further styles are applied, unlike the default style, which
only affects the style currently being applied (for example, setting the default
style to bold will cause subsequently inserted text to be bold).
Sets the default style, affecting the style currently being applied (for example, setting the default
style to bold will cause subsequently inserted text to be bold).
This is not cumulative – setting the default style will replace the previous default style.
Sets the list attributes for the given range, passing flags to determine how the attributes are set.
Either the style definition or the name of the style definition (in the current sheet) can be passed.
flags is a bit list of the following:
See also RichTextBuffer#number_list, RichTextBuffer#promote_list, RichTextBuffer#clear_list_style.
Sets renderer as the object to be used to render certain aspects of the content, such as bullets.
You can override default rendering by deriving a new class from RichTextRenderer or RichTextStdRenderer,
overriding one or more virtual functions, and setting an instance of the class using this function.
Sets the attributes for the given range. Pass flags to determine how the attributes are set.
The end point of range is specified as the last character position of the span of text.
So, for example, to set the style for a character at position 5, use the range (5,5).
This differs from the RichTextCtrl API, where you would specify (5,6).
flags may contain a bit list of the following values:
Sets the current style sheet, if any. This will allow the application to use
named character and paragraph styles found in the style sheet.
Submit an action immediately, or delay it according to whether collapsing is on.
Returns if undo suppression is currently on.
[This page automatically generated from the Textile source at 2023-06-13 21:31:37 +0000]