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

adjusted indentation with astyle; added Id keyword

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 14:43:31 +00:00
parent aa6ec1d787
commit 7c913512a4
269 changed files with 9052 additions and 9058 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
interface/richtext/richtextbuffer.h
View File

@@ -9,16 +9,16 @@
/**
@class wxRichTextBuffer
@headerfile richtextbuffer.h wx/richtext/richtextbuffer.h
This class represents the whole buffer associated with a wxRichTextCtrl.
@library{wxrichtext}
@category{FIXME}
@seealso
wxTextAttr, wxRichTextCtrl
*/
class wxRichTextBuffer
class wxRichTextBuffer
{
public:
//@{
@@ -26,7 +26,7 @@ public:
Default constructors.
*/
wxRichTextBuffer(const wxRichTextBuffer& obj);
wxRichTextBuffer();
wxRichTextBuffer();
//@}
/**
@@ -40,7 +40,7 @@ public:
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
during loading. The buffer never deletes any of the event handlers, unless
RemoveEventHandler() is
called with @true as the second argument.
*/
@@ -255,8 +255,8 @@ public:
*/
bool ClearListStyle(const wxRichTextRange& range,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
bool ClearListStyle(const wxRichTextRange& range,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
bool ClearListStyle(const wxRichTextRange& range,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
//@}
/**
@@ -290,7 +290,7 @@ public:
Dumps the contents of the buffer for debugging purposes.
*/
void Dump();
void Dump(wxTextOutputStream& stream);
void Dump(wxTextOutputStream& stream);
//@}
/**
@@ -408,16 +408,16 @@ public:
Finds a handler by name.
*/
wxRichTextFileHandler* FindHandler(int imageType);
wxRichTextFileHandler* FindHandler(const wxString& extension,
int imageType);
wxRichTextFileHandler* FindHandler(const wxString& name);
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
@@ -591,8 +591,8 @@ public:
*/
bool LoadFile(wxInputStream& stream,
int type = wxRICHTEXT_TYPE_ANY);
bool LoadFile(const wxString& filename,
int type = wxRICHTEXT_TYPE_ANY);
bool LoadFile(const wxString& filename,
int type = wxRICHTEXT_TYPE_ANY);
//@}
/**
@@ -622,11 +622,11 @@ public:
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 Number(const wxRichTextRange& range,
const wxString& styleName,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int startFrom = -1,
int listLevel = -1);
//@}
/**
@@ -656,10 +656,10 @@ public:
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 PromoteList(int promoteBy, const wxRichTextRange& range,
const wxString& styleName,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int listLevel = -1);
//@}
/**
@@ -685,8 +685,8 @@ public:
*/
bool SaveFile(wxOutputStream& stream,
int type = wxRICHTEXT_TYPE_ANY);
bool SaveFile(const wxString& filename,
int type = wxRICHTEXT_TYPE_ANY);
bool SaveFile(const wxString& filename,
int type = wxRICHTEXT_TYPE_ANY);
//@}
/**
@@ -729,11 +729,11 @@ public:
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);
bool SetListStyle(const wxRichTextRange& range,
const wxString& styleName,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int startFrom = -1,
int listLevel = -1);
//@}
/**
@@ -802,10 +802,10 @@ public:
/**
@class wxRichTextFileHandler
@headerfile richtextbuffer.h wx/richtext/richtextbuffer.h
This is the base class for file handlers, for loading and/or saving content
associated with a wxRichTextBuffer.
@library{wxrichtext}
@category{FIXME}
*/
@@ -884,8 +884,8 @@ public:
loading.
*/
bool LoadFile(wxRichTextBuffer* buffer, wxInputStream& stream);
bool LoadFile(wxRichTextBuffer* buffer,
const wxString& filename);
bool LoadFile(wxRichTextBuffer* buffer,
const wxString& filename);
//@}
//@{
@@ -893,8 +893,8 @@ public:
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);
//@}
/**
@@ -943,13 +943,13 @@ public:
/**
@class wxRichTextRange
@headerfile richtextbuffer.h wx/richtext/richtextbuffer.h
This class stores beginning and end positions for a range of data.
@library{wxrichtext}
@category{FIXME}
*/
class wxRichTextRange
class wxRichTextRange
{
public:
//@{
@@ -957,8 +957,8 @@ public:
Constructors.
*/
wxRichTextRange(long start, long end);
wxRichTextRange(const wxRichTextRange& range);
wxRichTextRange();
wxRichTextRange(const wxRichTextRange& range);
wxRichTextRange();
//@}
/**

90
interface/richtext/richtextctrl.h
View File

@@ -9,9 +9,9 @@
/**
@class wxRichTextEvent
@headerfile richtextctrl.h wx/richtext/richtextctrl.h
This is the event class for wxRichTextCtrl notifications.
@library{wxrichtext}
@category{events}
*/
@@ -23,8 +23,8 @@ public:
Constructors.
*/
wxRichTextEvent(const wxRichTextEvent& event);
wxRichTextEvent(wxEventType commandType = wxEVT_@NULL,
int winid = 0);
wxRichTextEvent(wxEventType commandType = wxEVT_@NULL,
int winid = 0);
//@}
/**
@@ -105,23 +105,23 @@ public:
/**
@class wxRichTextCtrl
@headerfile richtextctrl.h wx/richtext/richtextctrl.h
wxRichTextCtrl provides a generic, ground-up implementation of a text control
capable of showing multiple styles and images.
wxRichTextCtrl sends notification events: see wxRichTextEvent.
It also sends the standard wxTextCtrl events wxEVT_COMMAND_TEXT_ENTER and
wxEVT_COMMAND_TEXT_UPDATED,
and wxTextUrlEvent when URL content is clicked.
For more information, see the @ref overview_wxrichtextctrloverview
"wxRichTextCtrl overview".
@library{wxrichtext}
@category{ctrl}
@appearance{richtextctrl.png}
*/
class wxRichTextCtrl
class wxRichTextCtrl
{
public:
//@{
@@ -129,13 +129,13 @@ public:
Constructors.
*/
wxRichTextCtrl();
wxRichTextCtrl(wxWindow* parent, wxWindowID id = wxID_ANY,
const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxRE_MULTILINE,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxTextCtrlNameStr);
wxRichTextCtrl(wxWindow* parent, wxWindowID id = wxID_ANY,
const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxRE_MULTILINE,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxTextCtrlNameStr);
//@}
/**
@@ -401,8 +401,8 @@ public:
*/
bool ClearListStyle(const wxRichTextRange& range,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
bool ClearListStyle(const wxRichTextRange& range,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
bool ClearListStyle(const wxRichTextRange& range,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
//@}
/**
@@ -598,7 +598,7 @@ public:
Returns the buffer associated with the control.
*/
const wxRichTextBuffer GetBuffer();
wxRichTextBuffer GetBuffer();
wxRichTextBuffer GetBuffer();
//@}
/**
@@ -796,9 +796,9 @@ public:
scrolling).
*/
wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long* pos);
wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
wxTextCoord* col,
wxTextCoord* row);
wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
wxTextCoord* col,
wxTextCoord* row);
//@}
/**
@@ -1007,11 +1007,11 @@ public:
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 Number(const wxRichTextRange& range,
const wxString& styleName,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int startFrom = -1,
int listLevel = -1);
//@}
/**
@@ -1148,10 +1148,10 @@ public:
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 PromoteList(int promoteBy, const wxRichTextRange& range,
const wxString& styleName,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int listLevel = -1);
//@}
/**
@@ -1291,11 +1291,11 @@ public:
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);
bool SetListStyle(const wxRichTextRange& range,
const wxString& styleName,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int startFrom = -1,
int listLevel = -1);
//@}
/**
@@ -1329,7 +1329,7 @@ public:
*/
bool SetStyle(const wxRichTextRange& range,
const wxTextAttr& style);
bool SetStyle(long start, long end, const wxTextAttr& style);
bool SetStyle(long start, long end, const wxTextAttr& style);
//@}
//@{
@@ -1366,9 +1366,9 @@ public:
bool SetStyleEx(const wxRichTextRange& range,
const wxTextAttr& style,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
bool SetStyleEx(long start, long end,
const wxTextAttr& style,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
bool SetStyleEx(long start, long end,
const wxTextAttr& style,
int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
//@}
/**
@@ -1424,11 +1424,11 @@ public:
for internal and file storage of the raw data.
*/
bool WriteImage(const wxString& filename, int bitmapType);
bool WriteImage(const wxRichTextImageBlock& imageBlock);
bool WriteImage(const wxBitmap& bitmap,
int bitmapType = wxBITMAP_TYPE_PNG);
bool WriteImage(const wxImage& image,
int bitmapType = wxBITMAP_TYPE_PNG);
bool WriteImage(const wxRichTextImageBlock& imageBlock);
bool WriteImage(const wxBitmap& bitmap,
int bitmapType = wxBITMAP_TYPE_PNG);
bool WriteImage(const wxImage& image,
int bitmapType = wxBITMAP_TYPE_PNG);
//@}
/**

42
interface/richtext/richtextformatdlg.h
View File

@@ -9,7 +9,7 @@
/**
@class wxRichTextFormattingDialogFactory
@headerfile richtextformatdlg.h wx/richtext/richtextformatdlg.h
This class provides pages for wxRichTextFormattingDialog, and allows other
customization of the dialog.
A default instance of this class is provided automatically. If you wish to
@@ -18,7 +18,7 @@
class,
override one or more functions, and call the static function
wxRichTextFormattingDialog::SetFormattingDialogFactory.
@library{wxrichtext}
@category{FIXME}
*/
@@ -84,32 +84,32 @@ public:
/**
@class wxRichTextFormattingDialog
@headerfile richtextformatdlg.h wx/richtext/richtextformatdlg.h
This dialog allows the user to edit a character and/or paragraph style.
In the constructor, specify the pages that will be created. Use GetStyle
to retrieve the common style for a given range, and then use ApplyStyle
to apply the user-selected formatting to a control. For example:
@code
wxRichTextRange range;
if (m_richTextCtrl-HasSelection())
range = m_richTextCtrl-GetSelectionRange();
else
range = wxRichTextRange(0, m_richTextCtrl-GetLastPosition()+1);
int pages =
wxRICHTEXT_FORMAT_FONT|wxRICHTEXT_FORMAT_INDENTS_SPACING|wxRICHTEXT_FORMAT_TABS|wxRICHTEXT_FORMAT_BULLETS;
wxRichTextFormattingDialog formatDlg(pages, this);
formatDlg.GetStyle(m_richTextCtrl, range);
if (formatDlg.ShowModal() == wxID_OK)
{
formatDlg.ApplyStyle(m_richTextCtrl, range);
}
@endcode
@library{wxrichtext}
@category{cmndlg}
*/
@@ -120,30 +120,30 @@ public:
/**
Constructors.
@param flags
@param flags
The pages to show.
@param parent
@param parent
The dialog's parent.
@param id
@param id
The dialog's identifier.
@param title
@param title
The dialog's caption.
@param pos
@param pos
The dialog's position.
@param size
@param size
The dialog's size.
@param style
@param style
The dialog's window style.
*/
wxRichTextFormattingDialog(long flags, wxWindow* parent);
const wxPoint& pos = wxDefaultPosition, const wxSize& sz = wxDefaultSize, long style = wxDEFAULT_DIALOG_STYLE)
wxRichTextFormattingDialog();
const wxPoint& pos = wxDefaultPosition, const wxSize& sz = wxDefaultSize, long style = wxDEFAULT_DIALOG_STYLE)
wxRichTextFormattingDialog();
//@}
/**
@@ -166,15 +166,15 @@ public:
bool Create(long flags, wxWindow* parent, const wxString& title,
wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& sz = wxDefaultSize,
long style = wxDEFAULT_DIALOG_STYLE);
const wxSize& sz = wxDefaultSize,
long style = wxDEFAULT_DIALOG_STYLE);
//@{
/**
Gets the attributes being edited.
*/
const wxTextAttr GetAttributes();
wxTextAttr GetAttributes();
wxTextAttr GetAttributes();
//@}
/**

14
interface/richtext/richtexthtml.h
View File

@@ -9,20 +9,20 @@
/**
@class wxRichTextHTMLHandler
@headerfile richtexthtml.h wx/richtext/richtexthtml.h
Handles HTML output (only) for wxRichTextCtrl content.
The most flexible way to use this class is to create a temporary object and call
its functions directly, rather than use wxRichTextBuffer::SaveFile or
wxRichTextCtrl::SaveFile.
Image handling requires a little extra work from the application, to choose an
appropriate image format for the target HTML viewer and to clean up the
temporary images
later. If you are planning to load the HTML into a standard web browser, you can
specify the handler flag wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64 (the default)
and no extra work is required: the images will be written with the HTML.
However, if you want wxHTML compatibility, you will need to use
wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY
or wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES. In this case, you must either call
@@ -31,7 +31,7 @@
locations and delete them yourself when appropriate. You can call
wxRichTextHTMLHandler::GetTemporaryImageLocations to
get the array of temporary image names.
@library{wxrichtext}
@category{FIXME}
*/
@@ -59,8 +59,8 @@ public:
for example after the user has viewed the HTML file.
*/
bool DeleteTemporaryImages();
bool DeleteTemporaryImages(int flags,
const wxArrayString& imageLocations);
bool DeleteTemporaryImages(int flags,
const wxArrayString& imageLocations);
//@}
/**

20
interface/richtext/richtextprint.h
View File

@@ -9,12 +9,12 @@
/**
@class wxRichTextHeaderFooterData
@headerfile richtextprint.h wx/richtext/richtextprint.h
This class represents header and footer data to be passed to the
wxRichTextPrinting and
wxRichTextPrintout classes.
Headers and footers can be specified independently for odd, even or both page
sides. Different text can be specified
for left, centre and right locations on the page, and the font and text colour
@@ -22,14 +22,14 @@
be specified. You can specify the following keywords in header and footer text,
which will
be substituted for the actual values during printing and preview.
@DATE@: the current date.
@PAGESCNT@: the total number of pages.
@PAGENUM@: the current page number.
@TIME@: the current time.
@TITLE@: the title of the document, as passed to the wxRichTextPrinting or
wxRichTextLayout constructor.
@library{wxrichtext}
@category{FIXME}
*/
@@ -41,7 +41,7 @@ public:
Constructors.
*/
wxRichTextHeaderFooterData();
wxRichTextHeaderFooterData(const wxRichTextHeaderFooterData& data);
wxRichTextHeaderFooterData(const wxRichTextHeaderFooterData& data);
//@}
/**
@@ -159,11 +159,11 @@ public:
/**
@class wxRichTextPrintout
@headerfile richtextprint.h wx/richtext/richtextprint.h
This class implements print layout for wxRichTextBuffer. Instead of using it
directly, you
should normally use the wxRichTextPrinting class.
@library{wxrichtext}
@category{FIXME}
*/
@@ -238,10 +238,10 @@ public:
/**
@class wxRichTextPrinting
@headerfile richtextprint.h wx/richtext/richtextprint.h
This class provides a simple interface for performing wxRichTextBuffer printing
and previewing. It uses wxRichTextPrintout for layout and rendering.
@library{wxrichtext}
@category{FIXME}
*/

8
interface/richtext/richtextstyledlg.h
View File

@@ -9,13 +9,13 @@
/**
@class wxRichTextStyleOrganiserDialog
@headerfile richtextstyledlg.h wx/richtext/richtextstyledlg.h
This class shows a style sheet and allows the user to edit, add and remove
styles.
It can also be used as a style browser, for example if the application is not
using a permanent wxRichTextStyleComboCtrl or wxRichTextStyleListCtrl to
present styles.
@library{wxrichtext}
@category{FIXME}
*/
@@ -117,8 +117,8 @@ public:
wxRichTextCtrl* ctrl,
wxWindow* parent,
wxWindowID id = wxID_ANY);
const wxSize& size = wxDefaultSize, long style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX)
wxRichTextStyleOrganiserDialog();
const wxSize& size = wxDefaultSize, long style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX)
wxRichTextStyleOrganiserDialog();
//@}
/**

64
interface/richtext/richtextstyles.h
View File

@@ -9,11 +9,11 @@
/**
@class wxRichTextStyleListCtrl
@headerfile richtextstyles.h wx/richtext/richtextstyles.h
This class incorporates a wxRichTextStyleListBox and
a choice control that allows the user to select the category of style to view.
It is demonstrated in the wxRichTextCtrl sample in @c samples/richtext.
To use wxRichTextStyleListCtrl, add the control to your window hierarchy and
call wxRichTextStyleListCtrl::SetStyleType with
one of wxRichTextStyleListBox::wxRICHTEXT_STYLE_ALL,
@@ -23,12 +23,12 @@
Associate the control with a style sheet and rich text control with
SetStyleSheet and SetRichTextCtrl,
so that when a style is double-clicked, it is applied to the selection.
@beginStyleTable
@style{wxRICHTEXTSTYLELIST_HIDE_TYPE_SELECTOR}:
This style hides the category selection control.
@endStyleTable
@library{wxrichtext}
@category{FIXME}
*/
@@ -44,7 +44,7 @@ public:
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0);
wxRichTextStyleListCtrl();
wxRichTextStyleListCtrl();
//@}
/**
@@ -108,9 +108,9 @@ public:
/**
@class wxRichTextStyleDefinition
@headerfile richtextstyles.h wx/richtext/richtextstyles.h
This is a base class for paragraph and character styles.
@library{wxrichtext}
@category{FIXME}
*/
@@ -147,7 +147,7 @@ public:
Returns the attributes associated with this style.
*/
wxTextAttr GetStyle();
const wxTextAttr GetStyle();
const wxTextAttr GetStyle();
//@}
/**
@@ -181,10 +181,10 @@ public:
/**
@class wxRichTextParagraphStyleDefinition
@headerfile richtextstyles.h wx/richtext/richtextstyles.h
This class represents a paragraph style definition, usually added to a
wxRichTextStyleSheet.
@library{wxrichtext}
@category{FIXME}
*/
@@ -216,15 +216,15 @@ public:
/**
@class wxRichTextStyleListBox
@headerfile richtextstyles.h wx/richtext/richtextstyles.h
This is a listbox that can display the styles in a wxRichTextStyleSheet,
and apply the selection to an associated wxRichTextCtrl.
See @c samples/richtext for an example of how to use it.
@library{wxrichtext}
@category{FIXME}
@seealso
wxRichTextStyleComboCtrl, @ref overview_wxrichtextctrloverview "wxRichTextCtrl
overview"
@@ -339,15 +339,15 @@ public:
/**
@class wxRichTextStyleComboCtrl
@headerfile richtextstyles.h wx/richtext/richtextstyles.h
This is a combo control that can display the styles in a wxRichTextStyleSheet,
and apply the selection to an associated wxRichTextCtrl.
See @c samples/richtext for an example of how to use it.
@library{wxrichtext}
@category{FIXME}
@seealso
wxRichTextStyleListBox, @ref overview_wxrichtextctrloverview "wxRichTextCtrl
overview"
@@ -399,10 +399,10 @@ public:
/**
@class wxRichTextCharacterStyleDefinition
@headerfile richtextstyles.h wx/richtext/richtextstyles.h
This class represents a character style definition, usually added to a
wxRichTextStyleSheet.
@library{wxrichtext}
@category{FIXME}
*/
@@ -424,24 +424,24 @@ public:
/**
@class wxRichTextListStyleDefinition
@headerfile richtextstyles.h wx/richtext/richtextstyles.h
This class represents a list style definition, usually added to a
wxRichTextStyleSheet.
The class inherits paragraph attributes from
wxRichTextStyleParagraphDefinition, and adds 10 further attribute objects, one for each level of a list.
When applying a list style to a paragraph, the list style's base and
appropriate level attributes are merged with the
paragraph's existing attributes.
You can apply a list style to one or more paragraphs using
wxRichTextCtrl::SetListStyle. You
can also use the functions wxRichTextCtrl::NumberList,
wxRichTextCtrl::PromoteList and
wxRichTextCtrl::PromoteList and
wxRichTextCtrl::ClearListStyle. As usual, there are wxRichTextBuffer versions
of these functions
so that you can apply them directly to a buffer without requiring a control.
@library{wxrichtext}
@category{FIXME}
*/
@@ -517,10 +517,10 @@ public:
form is for convenient setting of the most commonly-used attributes.
*/
void SetLevelAttributes(int level, const wxTextAttr& attr);
void SetLevelAttributes(int level, int leftIndent,
int leftSubIndent,
int bulletStyle,
const wxString& bulletSymbol = wxEmptyString);
void SetLevelAttributes(int level, int leftIndent,
int leftSubIndent,
int bulletStyle,
const wxString& bulletSymbol = wxEmptyString);
//@}
};
@@ -528,14 +528,14 @@ public:
/**
@class wxRichTextStyleSheet
@headerfile richtextstyles.h wx/richtext/richtextstyles.h
A style sheet contains named paragraph and character styles that make it
easy for a user to apply combinations of attributes to a wxRichTextCtrl.
You can use a wxRichTextStyleListBox in your
user interface to show available styles to the user, and allow application
of styles to the control.
@library{wxrichtext}
@category{FIXME}
*/

50
interface/richtext/richtextsymboldlg.h
View File

@@ -9,14 +9,14 @@
/**
@class wxSymbolPickerDialog
@headerfile richtextsymboldlg.h wx/richtext/richtextsymboldlg.h
wxSymbolPickerDialog presents the user with a choice of fonts and a grid
of available characters. This modal dialog provides the application with
a selected symbol and optional font selection.
Although this dialog is contained in the rich text library, the dialog
is generic and can be used in other contexts.
To use the dialog, pass a default symbol specified as a string, an initial font
name,
and a current font name. The difference between the initial font and
@@ -28,39 +28,39 @@
to display the characters in, even when no initial font is selected.
This allows the user (and application) to distinguish between inserting a
symbol in the current font, and inserting it with a specified font.
When the dialog is dismissed, the application can get the selected symbol
with GetSymbol and test whether a font was specified with UseNormalFont,
fetching the specified font with GetFontName.
Here's a realistic example, inserting the supplied symbol into a
rich text control in either the current font or specified font.
@code
wxRichTextCtrl* ctrl = (wxRichTextCtrl*) FindWindow(ID_RICHTEXT_CTRL);
wxTextAttr attr;
attr.SetFlags(wxTEXT_ATTR_FONT);
ctrl-GetStyle(ctrl-GetInsertionPoint(), attr);
wxString currentFontName;
if (attr.HasFont() && attr.GetFont().Ok())
currentFontName = attr.GetFont().GetFaceName();
// Don't set the initial font in the dialog (so the user is choosing
// 'normal text', i.e. the current font) but do tell the dialog
// what 'normal text' is.
wxSymbolPickerDialog dlg(wxT("*"), wxEmptyString, currentFontName, this);
if (dlg.ShowModal() == wxID_OK)
{
if (dlg.HasSelection())
{
long insertionPoint = ctrl-GetInsertionPoint();
ctrl-WriteText(dlg.GetSymbol());
if (!dlg.UseNormalFont())
{
wxFont font(attr.GetFont());
@@ -71,7 +71,7 @@
}
}
@endcode
@library{wxrichtext}
@category{cmndlg}
*/
@@ -82,34 +82,34 @@ public:
/**
Constructors.
@param symbol
@param symbol
The initial symbol to show. Specify a single character in a string, or an empty
string.
@param initialFont
@param initialFont
The initial font to be displayed in the font list. If empty, the item normal
text will be selected.
@param normalTextFont
@param normalTextFont
The font the dialog will use to display the symbols if the initial font is
empty.
@param parent
@param parent
The dialog's parent.
@param id
@param id
The dialog's identifier.
@param title
@param title
The dialog's caption.
@param pos
@param pos
The dialog's position.
@param size
@param size
The dialog's size.
@param style
@param style
The dialog's window style.
*/
wxSymbolPickerDialog(const wxString& symbol,
@@ -117,8 +117,8 @@ public:
const wxString& normalTextFont,
wxWindow* parent,
wxWindowID id = wxID_ANY);
const wxSize& size = wxDefaultSize, long style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxCLOSE_BOX)
wxSymbolPickerDialog();
const wxSize& size = wxDefaultSize, long style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxCLOSE_BOX)
wxSymbolPickerDialog();
//@}
/**

4
interface/richtext/richtextxml.h
View File

@@ -9,13 +9,13 @@
/**
@class wxRichTextXMLHandler
@headerfile richtextxml.h wx/richtext/richtextxml.h
A handler for loading and saving content in an XML format specific
to wxRichTextBuffer. You can either add the handler to the buffer
and load and save through the buffer or control API, or you can
create an instance of the handler on the stack and call its
functions directly.
@library{wxrichtext}
@category{FIXME}
*/