wxRichTextBuffer Class Reference
[Rich Text]

#include <wx/richtext/richtextbuffer.h>

Detailed Description

This class represents the whole buffer associated with a wxRichTextCtrl.

See also:: wxTextAttr, wxRichTextCtrl


Public Member Functions
	wxRichTextBuffer ()
	wxRichTextBuffer (const wxRichTextBuffer &obj)
virtual	~wxRichTextBuffer ()
bool	AddEventHandler (wxEvtHandler *handler)
virtual wxRichTextRange	AddParagraph (const wxString &text, wxTextAttr *paraStyle=0)
virtual bool	BatchingUndo () const
bool	BeginAlignment (wxTextAttrAlignment alignment)
virtual bool	BeginBatchUndo (const wxString &cmdName)
bool	BeginBold ()
bool	BeginCharacterStyle (const wxString &characterStyle)
bool	BeginFont (const wxFont &font)
bool	BeginFontSize (int pointSize)
bool	BeginItalic ()
bool	BeginLeftIndent (int leftIndent, int leftSubIndent=0)
bool	BeginLineSpacing (int lineSpacing)
bool	BeginListStyle (const wxString &listStyle, int level=1, int number=1)
bool	BeginNumberedBullet (int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle=wxTEXT_ATTR_BULLET_STYLE_ARABIC\|wxTEXT_ATTR_BULLET_STYLE_PERIOD)
bool	BeginParagraphSpacing (int before, int after)
bool	BeginParagraphStyle (const wxString &paragraphStyle)
bool	BeginRightIndent (int rightIndent)
bool	BeginStandardBullet (const wxString &bulletName, int leftIndent, int leftSubIndent, int bulletStyle=wxTEXT_ATTR_BULLET_STYLE_STANDARD)
virtual bool	BeginStyle (const wxTextAttr &style)
virtual bool	BeginSuppressUndo ()
bool	BeginSymbolBullet (const wxString &symbol, int leftIndent, int leftSubIndent, int bulletStyle=wxTEXT_ATTR_BULLET_STYLE_SYMBOL)
bool	BeginTextColour (const wxColour &colour)
bool	BeginURL (const wxString &url, const wxString &characterStyle=wxEmptyString)
bool	BeginUnderline ()
virtual bool	CanPasteFromClipboard () const
virtual void	Clear ()
virtual void	ClearStyleStack ()
virtual wxRichTextObject *	Clone () const
void	Copy (const wxRichTextBuffer &obj)
virtual bool	CopyToClipboard (const wxRichTextRange &range)
bool	DeleteRangeWithUndo (const wxRichTextRange &range, wxRichTextCtrl *ctrl)
bool	EndAlignment ()
virtual bool	EndAllStyles ()
virtual bool	EndBatchUndo ()
bool	EndBold ()
bool	EndCharacterStyle ()
bool	EndFont ()
bool	EndFontSize ()
bool	EndItalic ()
bool	EndLeftIndent ()
bool	EndLineSpacing ()
bool	EndListStyle ()
bool	EndNumberedBullet ()
bool	EndParagraphSpacing ()
bool	EndParagraphStyle ()
bool	EndRightIndent ()
bool	EndStandardBullet ()
virtual bool	EndStyle ()
virtual bool	EndSuppressUndo ()
bool	EndSymbolBullet ()
bool	EndTextColour ()
bool	EndURL ()
bool	EndUnderline ()
virtual const wxTextAttr &	GetBasicStyle () const
virtual wxRichTextCommand *	GetBatchedCommand () const
wxCommandProcessor *	GetCommandProcessor () const
virtual const wxTextAttr &	GetDefaultStyle () const
virtual bool	GetStyle (long position, wxTextAttr &style)
virtual bool	GetStyleForRange (const wxRichTextRange &range, wxTextAttr &style)
virtual wxRichTextStyleSheet *	GetStyleSheet () const
virtual size_t	GetStyleStackSize () const
virtual bool	GetUncombinedStyle (long position, wxTextAttr &style)
virtual int	HitTest (wxDC &dc, const wxPoint &pt, long &textPosition)
void	Init ()
bool	InsertImageWithUndo (long pos, const wxRichTextImageBlock &imageBlock, wxRichTextCtrl *ctrl, int flags=0)
bool	InsertNewlineWithUndo (long pos, wxRichTextCtrl *ctrl, int flags=0)
bool	InsertTextWithUndo (long pos, const wxString &text, wxRichTextCtrl *ctrl, int flags=0)
bool	IsModified () const
virtual bool	LoadFile (wxInputStream &stream, wxRichTextFileType type=wxRICHTEXT_TYPE_ANY)
virtual bool	LoadFile (const wxString &filename, wxRichTextFileType type=wxRICHTEXT_TYPE_ANY)
void	Modify (bool modify=true)
virtual bool	PasteFromClipboard (long position)
bool	RemoveEventHandler (wxEvtHandler *handler, bool deleteHandler=false)
virtual void	ResetAndClearCommands ()
virtual bool	SaveFile (wxOutputStream &stream, wxRichTextFileType type=wxRICHTEXT_TYPE_ANY)
virtual bool	SaveFile (const wxString &filename, wxRichTextFileType type=wxRICHTEXT_TYPE_ANY)
virtual void	SetBasicStyle (const wxTextAttr &style)
virtual bool	SetDefaultStyle (const wxTextAttr &style)
virtual bool	SetStyle (const wxRichTextRange &range, const wxTextAttr &style, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO)
void	SetStyleSheet (wxRichTextStyleSheet *styleSheet)
virtual bool	SubmitAction (wxRichTextAction *action)
virtual bool	SuppressingUndo () const

bool	ClearListStyle (const wxRichTextRange &range, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO)
bool	ClearListStyle (const wxRichTextRange &range, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO)

void	Dump ()
void	Dump (wxTextOutputStream &stream)

bool	NumberList (const wxRichTextRange &range, const wxRichTextListStyleDefinition *style, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=-1, int listLevel=-1)
bool	Number (const wxRichTextRange &range, const wxString &styleName, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=-1, int listLevel=-1)

bool	PromoteList (int promoteBy, const wxRichTextRange &range, const wxRichTextListStyleDefinition *style, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int listLevel=-1)
bool	PromoteList (int promoteBy, const wxRichTextRange &range, const wxString &styleName, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int listLevel=-1)

bool	SetListStyle (const wxRichTextRange &range, const wxRichTextListStyleDefinition *style, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=-1, int listLevel=-1)
bool	SetListStyle (const wxRichTextRange &range, const wxString &styleName, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=-1, int listLevel=-1)
Static Public Member Functions
static void	AddHandler (wxRichTextFileHandler *handler)
static void	CleanUpHandlers ()
static wxRichTextFileHandler *	FindHandler (wxRichTextFileType imageType)
static wxRichTextFileHandler *	FindHandler (const wxString &extension, wxRichTextFileType imageType)
static wxRichTextFileHandler *	FindHandler (const wxString &name)
static wxRichTextFileHandler *	FindHandlerFilenameOrType (const wxString &filename, wxRichTextFileType imageType)
static wxString	GetExtWildcard (bool combine=false, bool save=false, wxArrayInt *types=NULL)
static wxList &	GetHandlers ()
static wxRichTextRenderer *	GetRenderer ()
static void	InitStandardHandlers ()
static void	InsertHandler (wxRichTextFileHandler *handler)
static bool	RemoveHandler (const wxString &name)
static void	SetRenderer (wxRichTextRenderer *renderer)

Constructor & Destructor Documentation

wxRichTextBuffer::wxRichTextBuffer ( )

Default constructor.

wxRichTextBuffer::wxRichTextBuffer ( const wxRichTextBuffer & obj )

Copy ctor.

virtual wxRichTextBuffer::~wxRichTextBuffer ( ) [virtual]

Destructor.

Member Function Documentation

bool wxRichTextBuffer::AddEventHandler ( wxEvtHandler * handler )

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.

static void wxRichTextBuffer::AddHandler ( wxRichTextFileHandler * handler ) [static]

Adds a file handler.

virtual wxRichTextRange wxRichTextBuffer::AddParagraph	(	const wxString &	text,
		wxTextAttr *	paraStyle = `0`
	)			`[virtual]`

Adds a paragraph of text.

virtual bool wxRichTextBuffer::BatchingUndo ( ) const [virtual]

Returns true if the buffer is currently collapsing commands into a single notional command.

bool wxRichTextBuffer::BeginAlignment ( wxTextAttrAlignment alignment )

Begins using alignment.

virtual bool wxRichTextBuffer::BeginBatchUndo ( const wxString & cmdName ) [virtual]

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.

bool wxRichTextBuffer::BeginBold ( )

Begin applying bold.

bool wxRichTextBuffer::BeginCharacterStyle ( const wxString & characterStyle )

Begins applying the named character style.

bool wxRichTextBuffer::BeginFont ( const wxFont & font )

Begins using this font.

bool wxRichTextBuffer::BeginFontSize ( int pointSize )

Begins using the given point size.

bool wxRichTextBuffer::BeginItalic ( )

Begins using italic.

bool wxRichTextBuffer::BeginLeftIndent	(	int	leftIndent,
		int	leftSubIndent = `0`
	)

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.

bool wxRichTextBuffer::BeginLineSpacing ( int lineSpacing )

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 wxTextAttrLineSpacing enumeration values are defined for convenience.

bool wxRichTextBuffer::BeginListStyle	(	const wxString &	listStyle,
		int	level = `1`,
		int	number = `1`
	)

Begins using a specified list style. Optionally, you can also pass a level and a number.

bool wxRichTextBuffer::BeginNumberedBullet	(	int	bulletNumber,
		int	leftIndent,
		int	leftSubIndent,
		int	bulletStyle = `wxTEXT_ATTR_BULLET_STYLE_ARABIC\|wxTEXT_ATTR_BULLET_STYLE_PERIOD`
	)

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:

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 wxRichTextBuffer::BeginParagraphSpacing	(	int	before,
		int	after
	)

Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of a millimetre.

bool wxRichTextBuffer::BeginParagraphStyle ( const wxString & paragraphStyle )

Begins applying the named paragraph style.

bool wxRichTextBuffer::BeginRightIndent ( int rightIndent )

Begins a right indent, specified in tenths of a millimetre.

bool wxRichTextBuffer::BeginStandardBullet	(	const wxString &	bulletName,
		int	leftIndent,
		int	leftSubIndent,
		int	bulletStyle = `wxTEXT_ATTR_BULLET_STYLE_STANDARD`
	)

Begins applying a standard bullet, using one of the standard bullet names (currently standard/circle or standard/square.

See BeginNumberedBullet() for an explanation of how indentation is used to render the bulleted paragraph.

virtual bool wxRichTextBuffer::BeginStyle ( const wxTextAttr & style ) [virtual]

Begins using a specified style.

virtual bool wxRichTextBuffer::BeginSuppressUndo ( ) [virtual]

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.

bool wxRichTextBuffer::BeginSymbolBullet	(	const wxString &	symbol,
		int	leftIndent,
		int	leftSubIndent,
		int	bulletStyle = `wxTEXT_ATTR_BULLET_STYLE_SYMBOL`
	)

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 wxRichTextBuffer::BeginTextColour ( const wxColour & colour )

Begins using the specified text foreground colour.

bool wxRichTextBuffer::BeginURL	(	const wxString &	url,
		const wxString &	characterStyle = `wxEmptyString`
	)

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 wxRichTextBuffer::BeginUnderline ( )

Begins using underline.

virtual bool wxRichTextBuffer::CanPasteFromClipboard ( ) const [virtual]

Returns true if content can be pasted from the clipboard.

static void wxRichTextBuffer::CleanUpHandlers ( ) [static]

Cleans up the file handlers.

virtual void wxRichTextBuffer::Clear ( ) [virtual]

Clears the buffer.

bool wxRichTextBuffer::ClearListStyle	(	const wxRichTextRange &	range,
		int	flags = `wxRICHTEXT_SETSTYLE_WITH_UNDO`
	)

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:

wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.

See also:: SetListStyle(), PromoteList(), NumberList()

bool wxRichTextBuffer::ClearListStyle	(	const wxRichTextRange &	range,
		int	flags = `wxRICHTEXT_SETSTYLE_WITH_UNDO`
	)

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:

wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.

See also:: SetListStyle(), PromoteList(), NumberList()

virtual void wxRichTextBuffer::ClearStyleStack ( ) [virtual]

Clears the style stack.

virtual wxRichTextObject* wxRichTextBuffer::Clone ( ) const [virtual]

Clones the object.

void wxRichTextBuffer::Copy ( const wxRichTextBuffer & obj )

Copies the given buffer.

virtual bool wxRichTextBuffer::CopyToClipboard ( const wxRichTextRange & range ) [virtual]

Copy the given range to the clipboard.

bool wxRichTextBuffer::DeleteRangeWithUndo	(	const wxRichTextRange &	range,
		wxRichTextCtrl *	ctrl
	)

Submits a command to delete the given range.

void wxRichTextBuffer::Dump ( )

Dumps the contents of the buffer for debugging purposes.

void wxRichTextBuffer::Dump ( wxTextOutputStream & stream )

Dumps the contents of the buffer for debugging purposes.

bool wxRichTextBuffer::EndAlignment ( )

Ends alignment.

virtual bool wxRichTextBuffer::EndAllStyles ( ) [virtual]

Ends all styles that have been started with a Begin... command.

virtual bool wxRichTextBuffer::EndBatchUndo ( ) [virtual]

Ends collapsing undo/redo commands, and submits the combined command.

bool wxRichTextBuffer::EndBold ( )

Ends using bold.

bool wxRichTextBuffer::EndCharacterStyle ( )

Ends using the named character style.

bool wxRichTextBuffer::EndFont ( )

Ends using a font.

bool wxRichTextBuffer::EndFontSize ( )

Ends using a point size.

bool wxRichTextBuffer::EndItalic ( )

Ends using italic.

bool wxRichTextBuffer::EndLeftIndent ( )

Ends using a left indent.

bool wxRichTextBuffer::EndLineSpacing ( )

Ends using a line spacing.

bool wxRichTextBuffer::EndListStyle ( )

Ends using a specified list style.

bool wxRichTextBuffer::EndNumberedBullet ( )

Ends a numbered bullet.

bool wxRichTextBuffer::EndParagraphSpacing ( )

Ends paragraph spacing.

bool wxRichTextBuffer::EndParagraphStyle ( )

Ends applying a named character style.

bool wxRichTextBuffer::EndRightIndent ( )

Ends using a right indent.

bool wxRichTextBuffer::EndStandardBullet ( )

Ends using a standard bullet.

virtual bool wxRichTextBuffer::EndStyle ( ) [virtual]

Ends the current style.

virtual bool wxRichTextBuffer::EndSuppressUndo ( ) [virtual]

Ends suppressing undo/redo commands.

bool wxRichTextBuffer::EndSymbolBullet ( )

Ends using a symbol bullet.

bool wxRichTextBuffer::EndTextColour ( )

Ends using a text foreground colour.

bool wxRichTextBuffer::EndURL ( )

Ends applying a URL.

bool wxRichTextBuffer::EndUnderline ( )

Ends using underline.

static wxRichTextFileHandler* wxRichTextBuffer::FindHandler ( wxRichTextFileType imageType ) [static]

Finds a handler by type.

static wxRichTextFileHandler* wxRichTextBuffer::FindHandler	(	const wxString &	extension,
		wxRichTextFileType	imageType
	)			`[static]`

Finds a handler by extension and type.

static wxRichTextFileHandler* wxRichTextBuffer::FindHandler ( const wxString & name ) [static]

Finds a handler by name.

static wxRichTextFileHandler* wxRichTextBuffer::FindHandlerFilenameOrType	(	const wxString &	filename,
		wxRichTextFileType	imageType
	)			`[static]`

Finds a handler by filename or, if supplied, type.

virtual const wxTextAttr& wxRichTextBuffer::GetBasicStyle ( ) const [virtual]

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

virtual wxRichTextCommand* wxRichTextBuffer::GetBatchedCommand ( ) const [virtual]

Gets the collapsed command.

wxCommandProcessor* wxRichTextBuffer::GetCommandProcessor ( ) const

Gets the command processor. A text buffer always creates its own command processor when it is initialized.

virtual const wxTextAttr& wxRichTextBuffer::GetDefaultStyle ( ) const [virtual]

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

static wxString wxRichTextBuffer::GetExtWildcard	(	bool	combine = `false`,
		bool	save = `false`,
		wxArrayInt *	types = `NULL`
	)			`[static]`

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 LoadFile() given a selected filter.

static wxList& wxRichTextBuffer::GetHandlers ( ) [static]

Returns the list of file handlers.

static wxRichTextRenderer* wxRichTextBuffer::GetRenderer ( ) [static]

Returns the object to be used to render certain aspects of the content, such as bullets.

virtual bool wxRichTextBuffer::GetStyle	(	long	position,
		wxTextAttr &	style
	)			`[virtual]`

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().

virtual bool wxRichTextBuffer::GetStyleForRange	(	const wxRichTextRange &	range,
		wxTextAttr &	style
	)			`[virtual]`

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 SetStyle() specifying the wxRICHTEXT_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.

virtual wxRichTextStyleSheet* wxRichTextBuffer::GetStyleSheet ( ) const [virtual]

Returns the current style sheet associated with the buffer, if any.

virtual size_t wxRichTextBuffer::GetStyleStackSize ( ) const [virtual]

Get the size of the style stack, for example to check correct nesting.

virtual bool wxRichTextBuffer::GetUncombinedStyle	(	long	position,
		wxTextAttr &	style
	)			`[virtual]`

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 GetStyle(). If you specify (any) paragraph attribute in style's flags, this function will fetch the paragraph attributes. Otherwise, it will return the character attributes.

virtual int wxRichTextBuffer::HitTest	(	wxDC &	dc,
		const wxPoint &	pt,
		long &	textPosition
	)			`[virtual]`

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

Returns:: One of the wxRichTextHitTestFlags values.

void wxRichTextBuffer::Init ( )

Initialisation.

static void wxRichTextBuffer::InitStandardHandlers ( ) [static]

Initialises the standard handlers. Currently, only the plain text loading/saving handler is initialised by default.

static void wxRichTextBuffer::InsertHandler ( wxRichTextFileHandler * handler ) [static]

Inserts a handler at the front of the list.

bool wxRichTextBuffer::InsertImageWithUndo	(	long	pos,
		const wxRichTextImageBlock &	imageBlock,
		wxRichTextCtrl *	ctrl,
		int	flags = `0`
	)

Submits a command to insert the given image.

bool wxRichTextBuffer::InsertNewlineWithUndo	(	long	pos,
		wxRichTextCtrl *	ctrl,
		int	flags = `0`
	)

Submits a command to insert a newline.

bool wxRichTextBuffer::InsertTextWithUndo	(	long	pos,
		const wxString &	text,
		wxRichTextCtrl *	ctrl,
		int	flags = `0`
	)

Submits a command to insert the given text.

bool wxRichTextBuffer::IsModified ( ) const

Returns true if the buffer has been modified.

virtual bool wxRichTextBuffer::LoadFile	(	wxInputStream &	stream,
		wxRichTextFileType	type = `wxRICHTEXT_TYPE_ANY`
	)			`[virtual]`

Loads content from a stream.

virtual bool wxRichTextBuffer::LoadFile	(	const wxString &	filename,
		wxRichTextFileType	type = `wxRICHTEXT_TYPE_ANY`
	)			`[virtual]`

Loads content from a file.

void wxRichTextBuffer::Modify ( bool modify = true )

Marks the buffer as modified or unmodified.

bool wxRichTextBuffer::NumberList	(	const wxRichTextRange &	range,
		const wxRichTextListStyleDefinition *	style,
		int	flags = `wxRICHTEXT_SETSTYLE_WITH_UNDO`,
		int	startFrom = `-1`,
		int	listLevel = `-1`
	)

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:

wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.

See also:: SetListStyle(), PromoteList(), ClearListStyle()

bool wxRichTextBuffer::Number	(	const wxRichTextRange &	range,
		const wxString &	styleName,
		int	flags = `wxRICHTEXT_SETSTYLE_WITH_UNDO`,
		int	startFrom = `-1`,
		int	listLevel = `-1`
	)

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:

wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.

See also:: SetListStyle(), PromoteList(), ClearListStyle()

virtual bool wxRichTextBuffer::PasteFromClipboard ( long position ) [virtual]

Pastes the clipboard content to the buffer at the given position.

bool wxRichTextBuffer::PromoteList	(	int	promoteBy,
		const wxRichTextRange &	range,
		const wxRichTextListStyleDefinition *	style,
		int	flags = `wxRICHTEXT_SETSTYLE_WITH_UNDO`,
		int	listLevel = `-1`
	)

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:

wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.

See also:: SetListStyle(), SetListStyle(), ClearListStyle()

bool wxRichTextBuffer::PromoteList	(	int	promoteBy,
		const wxRichTextRange &	range,
		const wxString &	styleName,
		int	flags = `wxRICHTEXT_SETSTYLE_WITH_UNDO`,
		int	listLevel = `-1`
	)

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:

wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.

See also:: SetListStyle(), SetListStyle(), ClearListStyle()

bool wxRichTextBuffer::RemoveEventHandler	(	wxEvtHandler *	handler,
		bool	deleteHandler = `false`
	)

Removes an event handler from the buffer's list of handlers, deleting the object if deleteHandler is true.

wxRichTextBuffer Class Reference [Rich Text]

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

wxRichTextBuffer Class Reference
[Rich Text]