Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

revised richtext headers

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56199 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-09 16:30:57 +00:00
parent 22c5cac637
commit 9e7ad1cab8
9 changed files with 900 additions and 635 deletions
Download Patch File Download Diff File Expand all files Collapse all files

537
interface/wx/richtext/richtextbuffer.h
View File

@@ -6,6 +6,130 @@
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/*!
* File types in wxRichText context.
*/
enum wxRichTextFileType
{
wxRICHTEXT_TYPE_ANY = 0,
wxRICHTEXT_TYPE_TEXT,
wxRICHTEXT_TYPE_XML,
wxRICHTEXT_TYPE_HTML,
wxRICHTEXT_TYPE_RTF,
wxRICHTEXT_TYPE_PDF
};
/*!
* Flags determining the available space, passed to Layout
*/
#define wxRICHTEXT_FIXED_WIDTH 0x01
#define wxRICHTEXT_FIXED_HEIGHT 0x02
#define wxRICHTEXT_VARIABLE_WIDTH 0x04
#define wxRICHTEXT_VARIABLE_HEIGHT 0x08
// Only lay out the part of the buffer that lies within
// the rect passed to Layout.
#define wxRICHTEXT_LAYOUT_SPECIFIED_RECT 0x10
/*!
* Flags to pass to Draw
*/
// Ignore paragraph cache optimization, e.g. for printing purposes
// where one line may be drawn higher (on the next page) compared
// with the previous line
#define wxRICHTEXT_DRAW_IGNORE_CACHE 0x01
/*!
* Flags returned from hit-testing
*/
enum wxRichTextHitTestFlags
{
/// The point was not on this object
wxRICHTEXT_HITTEST_NONE = 0x01,
/// The point was before the position returned from HitTest
wxRICHTEXT_HITTEST_BEFORE = 0x02,
/// The point was after the position returned from HitTest
wxRICHTEXT_HITTEST_AFTER = 0x04,
/// The point was on the position returned from HitTest
wxRICHTEXT_HITTEST_ON = 0x08,
/// The point was on space outside content
wxRICHTEXT_HITTEST_OUTSIDE = 0x10
};
/*!
* Flags for GetRangeSize
*/
#define wxRICHTEXT_FORMATTED 0x01
#define wxRICHTEXT_UNFORMATTED 0x02
#define wxRICHTEXT_CACHE_SIZE 0x04
#define wxRICHTEXT_HEIGHT_ONLY 0x08
/*!
* Flags for SetStyle/SetListStyle
*/
#define wxRICHTEXT_SETSTYLE_NONE 0x00
// Specifies that this operation should be undoable
#define wxRICHTEXT_SETSTYLE_WITH_UNDO 0x01
// Specifies that the style should not be applied if the
// combined style at this point is already the style in question.
#define wxRICHTEXT_SETSTYLE_OPTIMIZE 0x02
// Specifies that the style should only be applied to paragraphs,
// and not the content. This allows content styling to be
// preserved independently from that of e.g. a named paragraph style.
#define wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY 0x04
// Specifies that the style should only be applied to characters,
// and not the paragraph. This allows content styling to be
// preserved independently from that of e.g. a named paragraph style.
#define wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY 0x08
// For SetListStyle only: specifies starting from the given number, otherwise
// deduces number from existing attributes
#define wxRICHTEXT_SETSTYLE_RENUMBER 0x10
// For SetListStyle only: specifies the list level for all paragraphs, otherwise
// the current indentation will be used
#define wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL 0x20
// Resets the existing style before applying the new style
#define wxRICHTEXT_SETSTYLE_RESET 0x40
// Removes the given style instead of applying it
#define wxRICHTEXT_SETSTYLE_REMOVE 0x80
/*!
* Flags for text insertion
*/
#define wxRICHTEXT_INSERT_NONE 0x00
#define wxRICHTEXT_INSERT_WITH_PREVIOUS_PARAGRAPH_STYLE 0x01
#define wxRICHTEXT_INSERT_INTERACTIVE 0x02
// A special flag telling the buffer to keep the first paragraph style
// as-is, when deleting a paragraph marker. In future we might pass a
// flag to InsertFragment and DeleteRange to indicate the appropriate mode.
#define wxTEXT_ATTR_KEEP_FIRST_PARA_STYLE 0x10000000
/*!
* Default superscript/subscript font multiplication factor
*/
#define wxSCRIPT_MUL_FACTOR 1.5
/**
@class wxRichTextBuffer
@@ -16,16 +140,18 @@
@see wxTextAttr, wxRichTextCtrl
*/
class wxRichTextBuffer
class wxRichTextBuffer : public wxRichTextParagraphLayoutBox
{
public:
//@{
/**
Default constructors.
Default constructor.
*/
wxRichTextBuffer();
/**
Copy ctor.
*/
wxRichTextBuffer(const wxRichTextBuffer& obj);
wxRichTextBuffer();
//@}
/**
Destructor.
@@ -33,14 +159,15 @@ public:
virtual ~wxRichTextBuffer();
/**
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
RemoveEventHandler() is
called with @true as the second argument.
Adds an event handler to the buffer's list of handlers.
A buffer associated with a control 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 RemoveEventHandler()
is called with @true as the second argument.
*/
bool AddEventHandler(wxEvtHandler* handler);
@@ -69,6 +196,7 @@ public:
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.
@a cmdName should be the name of the combined command that will appear
next to Undo and Redo in the edit menu.
*/
@@ -100,48 +228,46 @@ public:
bool BeginItalic();
/**
Begin using @a leftIndent for the left indent, and optionally @a leftSubIndent
for
Begin using @a leftIndent for the left indent, and optionally @a 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.
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.
*/
bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0);
/**
Begins line spacing using the specified value. @e 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:
10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing.
The ::wxTextAttrLineSpacing enumeration values are defined for convenience.
*/
bool BeginLineSpacing(int lineSpacing);
/**
Begins using a specified list style. Optionally, you can also pass a level and
a number.
Begins using a specified list style.
Optionally, you can also pass a level and a number.
*/
bool BeginListStyle(const wxString& listStyle, int level = 1,
int number = 1);
/**
Begins a numbered bullet. This call will be needed for each item in the list,
and the
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.
@a bulletNumber is a number, usually starting with 1.
@a leftIndent and @a leftSubIndent are values in tenths of a millimetre.
@a bulletStyle is a bitlist of the following values:
wxRichTextBuffer 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
wxRichTextBuffer 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.
*/
bool BeginNumberedBullet(int bulletNumber, int leftIndent,
@@ -150,8 +276,7 @@ public:
/**
Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing
in tenths of
a millimetre.
in tenths of a millimetre.
*/
bool BeginParagraphSpacing(int before, int after);
@@ -168,6 +293,7 @@ public:
/**
Begins applying a standard bullet, using one of the standard bullet names
(currently @c standard/circle or @c standard/square.
See BeginNumberedBullet() for an explanation of how indentation is used to
render the bulleted paragraph.
*/
@@ -183,18 +309,18 @@ public:
/**
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.
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.
*/
virtual bool BeginSuppressUndo();
/**
Begins applying a symbol bullet, using a character from the current font. See
BeginNumberedBullet() 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 BeginNumberedBullet() for an explanation of how indentation is used
to render the bulleted paragraph.
*/
bool BeginSymbolBullet(wxChar symbol, int leftIndent,
int leftSubIndent,
@@ -206,10 +332,10 @@ public:
bool BeginTextColour(const wxColour& colour);
/**
Begins applying wxTEXT_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.
Begins applying wxTEXT_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.
*/
bool BeginURL(const wxString& url,
const wxString& characterStyle = wxEmptyString);
@@ -238,9 +364,11 @@ public:
/**
Clears the list style from the given range, clearing list-related attributes
and applying any named paragraph style associated with each paragraph.
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
See also SetListStyle(), PromoteList(), NumberList().
- wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
@see SetListStyle(), PromoteList(), NumberList()
*/
bool ClearListStyle(const wxRichTextRange& range,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
@@ -392,27 +520,35 @@ public:
*/
bool EndUnderline();
//@{
/**
Finds a handler by type.
*/
wxRichTextFileHandler* FindHandler(int imageType);
/**
Finds a handler by extension and type.
*/
wxRichTextFileHandler* FindHandler(const wxString& extension,
int imageType);
/**
Finds a handler by name.
*/
wxRichTextFileHandler* FindHandler(int imageType);
wxRichTextFileHandler* FindHandler(const wxString& extension,
int imageType);
wxRichTextFileHandler* FindHandler(const wxString& name);
//@}
/**
Finds a handler by filename or, if supplied, type.
*/
wxRichTextFileHandler* FindHandlerFilenameOrType(const wxString& filename,
int imageType);
int imageType);
/**
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 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).
*/
const wxTextAttr GetBasicStyle() const;
@@ -422,24 +558,23 @@ public:
virtual wxRichTextCommand* GetBatchedCommand() const;
/**
Gets the command processor. A text buffer always creates its own command
processor when it is
initialized.
Gets the command processor.
A text buffer always creates its own command processor when it is initialized.
*/
wxCommandProcessor* GetCommandProcessor() const;
/**
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).
(for example, setting the default style to bold will cause subsequently
inserted text to be bold).
*/
const wxTextAttr GetDefaultStyle() const;
/**
Gets a wildcard incorporating all visible handlers. If @a 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 @ref getextwildcard() LoadFile given a
selected filter.
Gets a wildcard incorporating all visible handlers.
If @a 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 LoadFile()
given a selected filter.
*/
wxString GetExtWildcard(bool combine = false, bool save = false,
wxArrayInt* types = NULL);
@@ -457,11 +592,11 @@ public:
/**
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 GetUncombinedStyle().
screen as a result of combining base style, paragraph style and character
style attributes. To get the character or paragraph style alone,
use GetUncombinedStyle().
*/
bool GetStyle(long position, wxTextAttr& style);
@@ -469,29 +604,24 @@ public:
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.
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.
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 SetStyle() specifying
the wxRICHTEXT_SETSTYLE_OPTIMIZE flag, which will only apply attributes that
are different
from the @e 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,
are different from the @e 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 @e will be changed to
show red.
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 @e will be changed to show red.
*/
bool GetStyleForRange(const wxRichTextRange& range,
wxTextAttr& style);
@@ -508,23 +638,22 @@ public:
/**
Gets the attributes at the given position.
This function gets the @e 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 GetStyle().
with the paragraph or character content, and not necessarily the combined
attributes you see on the screen. To get the combined attributes, use GetStyle().
If you specify (any) paragraph attribute in @e style's flags, this function
will fetch
the paragraph attributes. Otherwise, it will return the character attributes.
will fetch the paragraph attributes.
Otherwise, it will return the character attributes.
*/
bool GetUncombinedStyle(long position, wxTextAttr& style);
/**
Finds the text position for the given position, putting the position in @a
textPosition if
one is found. @a pt is in logical units (a zero y position is
at the beginning of the buffer).
The function returns one of the following values:
Finds the text position for the given position, putting the position in
@a textPosition if one is found.
@a pt is in logical units (a zero y position is at the beginning of the buffer).
@return One of the ::wxRichTextHitTestFlags values.
*/
int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition);
@@ -534,9 +663,8 @@ public:
void Init();
/**
Initialises the standard handlers. Currently, only the plain text
loading/saving handler
is initialised by default.
Initialises the standard handlers.
Currently, only the plain text loading/saving handler is initialised by default.
*/
static void InitStandardHandlers();
@@ -568,15 +696,17 @@ public:
*/
bool IsModified() const;
//@{
/**
Loads content from a file.
Loads content from a stream.
*/
bool LoadFile(wxInputStream& stream,
int type = wxRICHTEXT_TYPE_ANY);
/**
Loads content from a file.
*/
bool LoadFile(const wxString& filename,
int type = wxRICHTEXT_TYPE_ANY);
//@}
/**
Marks the buffer as modified or unmodified.
@@ -585,17 +715,20 @@ public:
//@{
/**
Numbers the paragraphs in the given range. Pass flags to determine how the
attributes are set.
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.
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from @e
startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
See also SetListStyle(), PromoteList(), ClearListStyle().
- wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
- wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
@a startFrom, otherwise existing attributes are used.
- wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
@see SetListStyle(), PromoteList(), ClearListStyle()
*/
bool NumberList(const wxRichTextRange& range,
const wxRichTextListStyleDefinition* style,
@@ -616,18 +749,21 @@ public:
//@{
/**
Promotes or demotes the paragraphs in the given range. A positive @a promoteBy
produces a smaller indent, and a negative number
Promotes or demotes the paragraphs in the given range.
A positive @a 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.
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from @e
startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
See also SetListStyle(), See also SetListStyle(), ClearListStyle().
- wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
- wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
@a startFrom, otherwise existing attributes are used.
- wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
@see SetListStyle(), SetListStyle(), ClearListStyle()
*/
bool PromoteList(int promoteBy, const wxRichTextRange& range,
const wxRichTextListStyleDefinition* style,
@@ -656,15 +792,17 @@ public:
*/
virtual void ResetAndClearCommands();
//@{
/**
Saves content to a file.
Saves content to a stream.
*/
bool SaveFile(wxOutputStream& stream,
int type = wxRICHTEXT_TYPE_ANY);
/**
Saves content to a file.
*/
bool SaveFile(const wxString& filename,
int type = wxRICHTEXT_TYPE_ANY);
//@}
/**
Sets the basic (overall) style. This is the style of the whole
@@ -675,9 +813,10 @@ public:
void SetBasicStyle(const wxTextAttr& style);
/**
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).
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.
*/
@@ -689,13 +828,15 @@ public:
the attributes are set.
Either the style definition or the name of the style definition (in the current
sheet) can be passed.
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from @e
startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
See also NumberList(), PromoteList(), ClearListStyle().
- wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
- wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
@a startFrom, otherwise existing attributes are used.
- wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
@see NumberList(), PromoteList(), ClearListStyle().
*/
bool SetListStyle(const wxRichTextRange& range,
const wxRichTextListStyleDefinition* style,
@@ -712,48 +853,50 @@ public:
/**
Sets @a 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
wxRichTextRenderer or wxRichTextStdRenderer,
overriding one or more virtual functions, and setting an instance of the class
using this function.
wxRichTextRenderer or wxRichTextStdRenderer, overriding one or more
virtual functions, and setting an instance of the class using this function.
*/
static void SetRenderer(wxRichTextRenderer* renderer);
/**
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).
of text. So, for example, to set the style for a character at position 5,
use the range (5,5).
This differs from the wxRichTextCtrl API, where you would specify (5,6).
@a flags may contain a bit list of the following values:
wxRICHTEXT_SETSTYLE_NONE: no style flag.
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this operation should be
undoable.
wxRICHTEXT_SETSTYLE_OPTIMIZE: specifies that the style should not be applied
if the
combined style at this point is already the style in question.
wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY: specifies that the style should only be
applied to paragraphs,
and not the content. This allows content styling to be preserved independently
from that of e.g. a named paragraph style.
wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY: specifies that the style should only be
applied to characters,
and not the paragraph. This allows content styling to be preserved
independently from that of e.g. a named paragraph style.
wxRICHTEXT_SETSTYLE_RESET: resets (clears) the existing style before applying
the new style.
wxRICHTEXT_SETSTYLE_REMOVE: removes the specified style. Only the style flags
are used in this operation.
- wxRICHTEXT_SETSTYLE_NONE: no style flag.
- wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this operation should be
undoable.
- wxRICHTEXT_SETSTYLE_OPTIMIZE: specifies that the style should not be applied
if the combined style at this point is already the style in question.
- wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY: specifies that the style should only be
applied to paragraphs, and not the content.
This allows content styling to be preserved independently from that
of e.g. a named paragraph style.
- wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY: specifies that the style should only be
applied to characters, and not the paragraph.
This allows content styling to be preserved independently from that
of e.g. a named paragraph style.
- wxRICHTEXT_SETSTYLE_RESET: resets (clears) the existing style before applying
the new style.
- wxRICHTEXT_SETSTYLE_REMOVE: removes the specified style.
Only the style flags are used in this operation.
*/
bool SetStyle(const wxRichTextRange& range,
const wxTextAttr& style,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
/**
Sets the current style sheet, if any. This will allow the application to use
named character and paragraph styles found in the style sheet.
Sets the current style sheet, if any.
This will allow the application to use named character and paragraph
styles found in the style sheet.
*/
void SetStyleSheet(wxRichTextStyleSheet* styleSheet);
@@ -790,9 +933,10 @@ public:
int type = 0);
/**
Override this function and return @true if this handler can we handle @e
filename. By default,
this function checks the extension.
Override this function and return @true if this handler can we handle
@a filename.
By default, this function checks the extension.
*/
virtual bool CanHandle(const wxString& filename) const;
@@ -807,12 +951,12 @@ public:
virtual bool CanSave() const;
/**
Override to load content from @a stream into @e buffer.
Override to load content from @a stream into @a buffer.
*/
bool DoLoadFile(wxRichTextBuffer* buffer, wxInputStream& stream);
/**
Override to save content to @a stream from @e buffer.
Override to save content to @a stream from @a buffer.
*/
bool DoSaveFile(wxRichTextBuffer* buffer, wxOutputStream& stream);
@@ -827,9 +971,10 @@ public:
wxString GetExtension() const;
/**
Returns flags that change the behaviour of loading or saving. See the
documentation for each
handler class to see what flags are relevant for each handler.
Returns flags that change the behaviour of loading or saving.
See the documentation for each handler class to see what flags are
relevant for each handler.
*/
int GetFlags() const;
@@ -850,26 +995,25 @@ public:
//@{
/**
Loads content from a stream or file. Not all handlers will implement file
loading.
Loads content from a stream or file.
Not all handlers will implement file loading.
*/
bool LoadFile(wxRichTextBuffer* buffer, wxInputStream& stream);
bool LoadFile(wxRichTextBuffer* buffer,
const wxString& filename);
bool LoadFile(wxRichTextBuffer* buffer, const wxString& filename);
//@}
//@{
/**
Saves content to a stream or file. Not all handlers will implement file saving.
Saves content to a stream or file.
Not all handlers will implement file saving.
*/
bool SaveFile(wxRichTextBuffer* buffer, wxOutputStream& stream);
bool SaveFile(wxRichTextBuffer* buffer,
const wxString& filename);
bool SaveFile(wxRichTextBuffer* buffer, const wxString& filename);
//@}
/**
Sets the encoding to use when saving a file. If empty, a suitable encoding is
chosen.
Sets the encoding to use when saving a file.
If empty, a suitable encoding is chosen.
*/
void SetEncoding(const wxString& encoding);
@@ -879,14 +1023,14 @@ public:
void SetExtension(const wxString& ext);
/**
Sets flags that change the behaviour of loading or saving. See the
documentation for each
handler class to see what flags are relevant for each handler.
Sets flags that change the behaviour of loading or saving.
See the documentation for each handler class to see what flags are relevant
for each handler.
You call this function directly if you are using a file handler explicitly
(without
going through the text control or buffer LoadFile/SaveFile API). Or, you can
call the control or buffer's SetHandlerFlags function to set the flags that will
be used for subsequent load and save operations.
(without going through the text control or buffer LoadFile/SaveFile API).
Or, you can call the control or buffer's SetHandlerFlags function to set
the flags that will be used for subsequent load and save operations.
*/
void SetFlags(int flags);
@@ -902,8 +1046,7 @@ public:
/**
Sets whether the handler should be visible to the user (via the application's
load and save
dialogs).
load and save dialogs).
*/
virtual void SetVisible(bool visible);
};
@@ -936,16 +1079,15 @@ public:
~wxRichTextRange();
/**
Returns @true if the given position is within this range. Does not
match if the range is empty.
Returns @true if the given position is within this range.
Does not match if the range is empty.
*/
bool Contains(long pos) const;
/**
Converts the internal range, which uses the first and last character positions
of the range,
to the API-standard range, whose end is one past the last character in the
range.
of the range, to the API-standard range, whose end is one past the last
character in the range.
In other words, one is added to the end position.
*/
wxRichTextRange FromInternal() const;
@@ -1002,9 +1144,8 @@ public:
/**
Converts the API-standard range, whose end is one past the last character in
the range,
to the internal form, which uses the first and last character positions of the
range.
the range, to the internal form, which uses the first and last character
positions of the range.
In other words, one is subtracted from the end position.
*/
wxRichTextRange ToInternal() const;