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

HUGE commit of ifacecheck-automated fixes to virtualness/constness/staticness of wxWidgets documented functions

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55912 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-09-27 11:21:10 +00:00
parent e7d0a28b01
commit adaaa68635
133 changed files with 1080 additions and 1080 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
interface/wx/dataobj.h
View File

@@ -542,7 +542,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDataObject(); virtual ~wxDataObject();
/** /**
Copy all supported formats in the given direction to the array pointed Copy all supported formats in the given direction to the array pointed
@@ -686,7 +686,7 @@ public:
Adds a file to the file list represented by this data object (Windows Adds a file to the file list represented by this data object (Windows
only). only).
*/ */
virtual void AddFile(const wxString& file); void AddFile(const wxString& file);
/** /**
Returns the array of file names. Returns the array of file names.

68
interface/wx/dataview.h
View File

@@ -87,7 +87,7 @@ public:
Returns a pointer to the wxDataViewColumn from which Returns a pointer to the wxDataViewColumn from which
the event was emitted or @NULL. the event was emitted or @NULL.
*/ */
wxDataViewColumn* GetDataViewColumn(); wxDataViewColumn* GetDataViewColumn() const;
/** /**
Returns the wxDataViewModel associated with the event. Returns the wxDataViewModel associated with the event.
@@ -420,7 +420,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDataViewIndexListModel(); virtual ~wxDataViewIndexListModel();
/** /**
Compare method that sorts the items by their index. Compare method that sorts the items by their index.
@@ -727,7 +727,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDataViewCtrl(); virtual ~wxDataViewCtrl();
/** /**
Appends a wxDataViewColumn to the control. Returns @true on success. Appends a wxDataViewColumn to the control. Returns @true on success.
@@ -897,7 +897,7 @@ public:
/** /**
Collapses the item. Collapses the item.
*/ */
void Collapse(const wxDataViewItem& item); virtual void Collapse(const wxDataViewItem& item);
/** /**
Create the control. Useful for two step creation. Create the control. Useful for two step creation.
@@ -922,7 +922,7 @@ public:
/** /**
Expands the item. Expands the item.
*/ */
void Expand(const wxDataViewItem& item); virtual void Expand(const wxDataViewItem& item);
/** /**
Returns pointer to the column. @a pos refers to the Returns pointer to the column. @a pos refers to the
@@ -961,18 +961,18 @@ public:
Returns pointer to the data model associated with the Returns pointer to the data model associated with the
control (if any). control (if any).
*/ */
virtual wxDataViewModel* GetModel() const; wxDataViewModel* GetModel();
/** /**
Returns first selected item or an invalid item if none is selected. Returns first selected item or an invalid item if none is selected.
*/ */
wxDataViewItem GetSelection() const; virtual wxDataViewItem GetSelection() const;
/** /**
Fills @a sel with currently selected items and returns Fills @a sel with currently selected items and returns
their number. their number.
*/ */
int GetSelections(wxDataViewItemArray& sel) const; virtual int GetSelections(wxDataViewItemArray& sel) const;
/** /**
Returns the wxDataViewColumn currently responsible for sorting Returns the wxDataViewColumn currently responsible for sorting
@@ -989,17 +989,17 @@ public:
/** /**
Return @true if the item is selected. Return @true if the item is selected.
*/ */
bool IsSelected(const wxDataViewItem& item) const; virtual bool IsSelected(const wxDataViewItem& item) const;
/** /**
Select the given item. Select the given item.
*/ */
void Select(const wxDataViewItem& item); virtual void Select(const wxDataViewItem& item);
/** /**
Select all items. Select all items.
*/ */
void SelectAll(); virtual void SelectAll();
/** /**
Set which column shall contain the tree-like expanders. Set which column shall contain the tree-like expanders.
@@ -1014,18 +1014,18 @@ public:
/** /**
Sets the selection to the array of wxDataViewItems. Sets the selection to the array of wxDataViewItems.
*/ */
void SetSelections(const wxDataViewItemArray& sel); virtual void SetSelections(const wxDataViewItemArray& sel);
/** /**
Unselect the given item. Unselect the given item.
*/ */
void Unselect(const wxDataViewItem& item); virtual void Unselect(const wxDataViewItem& item);
/** /**
Unselect all item. This method only has effect if multiple Unselect all item. This method only has effect if multiple
selections are allowed. selections are allowed.
*/ */
void UnselectAll(); virtual void UnselectAll();
}; };
@@ -1053,7 +1053,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDataViewModelNotifier(); virtual ~wxDataViewModelNotifier();
/** /**
Called by owning model. Called by owning model.
@@ -1091,7 +1091,7 @@ public:
/** /**
Called by owning model. Called by owning model.
*/ */
bool ItemsChanged(const wxDataViewItemArray& items); virtual bool ItemsChanged(const wxDataViewItemArray& items);
/** /**
Called by owning model. Called by owning model.
@@ -1190,12 +1190,12 @@ public:
/** /**
Returns the cell mode. Returns the cell mode.
*/ */
virtual wxDataViewCellMode GetMode(); virtual wxDataViewCellMode GetMode() const;
/** /**
Returns pointer to the owning wxDataViewColumn. Returns pointer to the owning wxDataViewColumn.
*/ */
virtual wxDataViewColumn* GetOwner() const; wxDataViewColumn* GetOwner() const;
/** /**
This methods retrieves the value from the renderer in order to This methods retrieves the value from the renderer in order to
@@ -1208,7 +1208,7 @@ public:
Returns a string with the type of the wxVariant Returns a string with the type of the wxVariant
supported by this renderer. supported by this renderer.
*/ */
virtual wxString GetVariantType(); wxString GetVariantType() const;
/** /**
Sets the alignment of the renderer's content. The default value Sets the alignment of the renderer's content. The default value
@@ -1223,7 +1223,7 @@ public:
Sets the owning wxDataViewColumn. This Sets the owning wxDataViewColumn. This
is usually called from within wxDataViewColumn. is usually called from within wxDataViewColumn.
*/ */
virtual void SetOwner(wxDataViewColumn* owner); void SetOwner(wxDataViewColumn* owner);
/** /**
Set the value of the renderer (and thus its cell) to @e value. Set the value of the renderer (and thus its cell) to @e value.
@@ -1442,7 +1442,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDataViewCustomRenderer(); virtual ~wxDataViewCustomRenderer();
/** /**
Override this to react to double clicks or ENTER. This method will Override this to react to double clicks or ENTER. This method will
@@ -1582,7 +1582,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDataViewColumn(); virtual ~wxDataViewColumn();
/** /**
Returns the bitmap in the header of the column, if any. Returns the bitmap in the header of the column, if any.
@@ -1593,7 +1593,7 @@ public:
Returns the index of the column of the model, which this Returns the index of the column of the model, which this
wxDataViewColumn is displaying. wxDataViewColumn is displaying.
*/ */
unsigned int GetModelColumn(); unsigned int GetModelColumn() const;
/** /**
Returns the owning wxDataViewCtrl. Returns the owning wxDataViewCtrl.
@@ -1604,7 +1604,7 @@ public:
Returns the renderer of this wxDataViewColumn. Returns the renderer of this wxDataViewColumn.
See also wxDataViewRenderer. See also wxDataViewRenderer.
*/ */
wxDataViewRenderer* GetRenderer(); wxDataViewRenderer* GetRenderer() const;
/** /**
Returns @true if the column is reorderable. Returns @true if the column is reorderable.
@@ -1620,37 +1620,37 @@ public:
/** /**
Returns the width of the column. Returns the width of the column.
*/ */
int GetWidth(); virtual int GetWidth() const;
/** /**
Returns @true, if the sort order is ascending. Returns @true, if the sort order is ascending.
See also SetSortOrder() See also SetSortOrder()
*/ */
bool IsSortOrderAscending(); virtual bool IsSortOrderAscending() const;
/** /**
Set the alignment of the column header. Set the alignment of the column header.
*/ */
void SetAlignment(wxAlignment align); virtual void SetAlignment(wxAlignment align);
/** /**
Set the bitmap of the column header. Set the bitmap of the column header.
*/ */
void SetBitmap(const wxBitmap& bitmap); virtual void SetBitmap(const wxBitmap& bitmap);
/** /**
Indicate wether the column can be reordered by the Indicate wether the column can be reordered by the
user using the mouse. This is typically implemented user using the mouse. This is typically implemented
visually by dragging the header button around. visually by dragging the header button around.
*/ */
void SetReorderable(bool reorderable); virtual void SetReorderable(bool reorderable);
/** /**
Indicate the sort order if the implementation of the Indicate the sort order if the implementation of the
wxDataViewCtrl supports it, most commonly by showing wxDataViewCtrl supports it, most commonly by showing
a little arrow. a little arrow.
*/ */
void SetSortOrder(bool ascending); virtual void SetSortOrder(bool ascending);
/** /**
Indicate that the column is sortable. This does Indicate that the column is sortable. This does
@@ -1662,12 +1662,12 @@ public:
no longer clickable and the sort indicator (little no longer clickable and the sort indicator (little
arrow) will disappear. arrow) will disappear.
*/ */
void SetSortable(bool sortable); virtual void SetSortable(bool sortable);
/** /**
Set the title of the column header to @e title. Set the title of the column header to @e title.
*/ */
void SetTitle(const wxString& title); virtual void SetTitle(const wxString& title);
}; };
@@ -1704,7 +1704,7 @@ public:
/** /**
Destructor. Deletes the image list if any. Destructor. Deletes the image list if any.
*/ */
~wxDataViewTreeCtrl(); virtual ~wxDataViewTreeCtrl();
/** /**
@@ -1886,7 +1886,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDataViewTreeStore(); virtual ~wxDataViewTreeStore();
/** /**
Append a container. Append a container.

34
interface/wx/dc.h
View File

@@ -161,27 +161,27 @@ public:
Convert device X coordinate to logical coordinate, using the current Convert device X coordinate to logical coordinate, using the current
mapping mode, user scale factor, device origin and axis orientation. mapping mode, user scale factor, device origin and axis orientation.
*/ */
virtual wxCoord DeviceToLogicalX(wxCoord x); wxCoord DeviceToLogicalX(wxCoord x) const;
/** /**
Convert device X coordinate to relative logical coordinate, using the Convert device X coordinate to relative logical coordinate, using the
current mapping mode and user scale factor but ignoring the current mapping mode and user scale factor but ignoring the
axis orientation. Use this for converting a width, for example. axis orientation. Use this for converting a width, for example.
*/ */
virtual wxCoord DeviceToLogicalXRel(wxCoord x); wxCoord DeviceToLogicalXRel(wxCoord x) const;
/** /**
Converts device Y coordinate to logical coordinate, using the current Converts device Y coordinate to logical coordinate, using the current
mapping mode, user scale factor, device origin and axis orientation. mapping mode, user scale factor, device origin and axis orientation.
*/ */
virtual wxCoord DeviceToLogicalY(wxCoord y); wxCoord DeviceToLogicalY(wxCoord y) const;
/** /**
Convert device Y coordinate to relative logical coordinate, using the Convert device Y coordinate to relative logical coordinate, using the
current mapping mode and user scale factor but ignoring the current mapping mode and user scale factor but ignoring the
axis orientation. Use this for converting a height, for example. axis orientation. Use this for converting a height, for example.
*/ */
virtual wxCoord DeviceToLogicalYRel(wxCoord y); wxCoord DeviceToLogicalYRel(wxCoord y) const;
/** /**
Draws an arc of a circle, centred on (@a xc, @a yc), with starting Draws an arc of a circle, centred on (@a xc, @a yc), with starting
@@ -502,12 +502,12 @@ public:
/** /**
Gets the character height of the currently set font. Gets the character height of the currently set font.
*/ */
wxCoord GetCharHeight(); wxCoord GetCharHeight() const;
/** /**
Gets the average character width of the currently set font. Gets the average character width of the currently set font.
*/ */
wxCoord GetCharWidth(); wxCoord GetCharWidth() const;
/** /**
Gets the rectangle surrounding the current clipping region. Gets the rectangle surrounding the current clipping region.
@@ -549,14 +549,14 @@ public:
@see SetLogicalFunction() @see SetLogicalFunction()
*/ */
int GetLogicalFunction(); int GetLogicalFunction() const;
/** /**
Gets the mapping mode for the device context. Gets the mapping mode for the device context.
@see SetMapMode() @see SetMapMode()
*/ */
int GetMapMode(); int GetMapMode() const;
/** /**
Gets the dimensions of the string using the currently selected font. Gets the dimensions of the string using the currently selected font.
@@ -625,7 +625,7 @@ public:
The wxColour value is returned and is not required as a parameter. The wxColour value is returned and is not required as a parameter.
@endWxPythonOnly @endWxPythonOnly
*/ */
bool GetPixel(wxCoord x, wxCoord y, wxColour* colour); bool GetPixel(wxCoord x, wxCoord y, wxColour* colour) const;
/** /**
Returns the resolution of the device in pixels per inch. Returns the resolution of the device in pixels per inch.
@@ -766,47 +766,47 @@ public:
Converts logical X coordinate to device coordinate, using the current Converts logical X coordinate to device coordinate, using the current
mapping mode, user scale factor, device origin and axis orientation. mapping mode, user scale factor, device origin and axis orientation.
*/ */
virtual wxCoord LogicalToDeviceX(wxCoord x); wxCoord LogicalToDeviceX(wxCoord x) const;
/** /**
Converts logical X coordinate to relative device coordinate, using the Converts logical X coordinate to relative device coordinate, using the
current mapping mode and user scale factor but ignoring the current mapping mode and user scale factor but ignoring the
axis orientation. Use this for converting a width, for example. axis orientation. Use this for converting a width, for example.
*/ */
virtual wxCoord LogicalToDeviceXRel(wxCoord x); wxCoord LogicalToDeviceXRel(wxCoord x) const;
/** /**
Converts logical Y coordinate to device coordinate, using the current Converts logical Y coordinate to device coordinate, using the current
mapping mode, user scale factor, device origin and axis orientation. mapping mode, user scale factor, device origin and axis orientation.
*/ */
virtual wxCoord LogicalToDeviceY(wxCoord y); wxCoord LogicalToDeviceY(wxCoord y) const;
/** /**
Converts logical Y coordinate to relative device coordinate, using the Converts logical Y coordinate to relative device coordinate, using the
current mapping mode and user scale factor but ignoring the current mapping mode and user scale factor but ignoring the
axis orientation. Use this for converting a height, for example. axis orientation. Use this for converting a height, for example.
*/ */
virtual wxCoord LogicalToDeviceYRel(wxCoord y); wxCoord LogicalToDeviceYRel(wxCoord y) const;
/** /**
Gets the maximum horizontal extent used in drawing commands so far. Gets the maximum horizontal extent used in drawing commands so far.
*/ */
wxCoord MaxX(); wxCoord MaxX() const;
/** /**
Gets the maximum vertical extent used in drawing commands so far. Gets the maximum vertical extent used in drawing commands so far.
*/ */
wxCoord MaxY(); wxCoord MaxY() const;
/** /**
Gets the minimum horizontal extent used in drawing commands so far. Gets the minimum horizontal extent used in drawing commands so far.
*/ */
wxCoord MinX(); wxCoord MinX() const;
/** /**
Gets the minimum vertical extent used in drawing commands so far. Gets the minimum vertical extent used in drawing commands so far.
*/ */
wxCoord MinY(); wxCoord MinY() const;
/** /**
Resets the bounding box: after a call to this function, the bounding Resets the bounding box: after a call to this function, the bounding

6
interface/wx/dcscreen.h
View File

@@ -31,7 +31,7 @@ public:
This function destroys the temporary window created to implement on-top This function destroys the temporary window created to implement on-top
drawing (X only). drawing (X only).
*/ */
bool EndDrawingOnTop(); static bool EndDrawingOnTop();
/** /**
Use this in conjunction with EndDrawingOnTop() to ensure that drawing Use this in conjunction with EndDrawingOnTop() to ensure that drawing
@@ -54,7 +54,7 @@ public:
that this function allows the screen to be refreshed that this function allows the screen to be refreshed
afterwards, may be useful to some applications. afterwards, may be useful to some applications.
*/ */
bool StartDrawingOnTop(wxWindow* window); static bool StartDrawingOnTop(wxWindow* window);
/** /**
Use this in conjunction with EndDrawingOnTop() to ensure that drawing Use this in conjunction with EndDrawingOnTop() to ensure that drawing
to the screen occurs on top of existing windows. Without this, some to the screen occurs on top of existing windows. Without this, some
@@ -77,6 +77,6 @@ public:
that this function allows the screen to be refreshed that this function allows the screen to be refreshed
afterwards, may be useful to some applications. afterwards, may be useful to some applications.
*/ */
bool StartDrawingOnTop(wxRect* rect = NULL); static bool StartDrawingOnTop(wxRect* rect = NULL);
}; };

2
interface/wx/dcsvg.h
View File

@@ -55,7 +55,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxSVGFileDC(); virtual ~wxSVGFileDC();
/** /**
Copies from a source DC to this DC, specifying the destination Copies from a source DC to this DC, specifying the destination

8
interface/wx/debugrpt.h
View File

@@ -135,7 +135,7 @@ public:
constructor with all the files it contains. Call Reset() to prevent constructor with all the files it contains. Call Reset() to prevent
this from happening. this from happening.
*/ */
~wxDebugReport(); virtual ~wxDebugReport();
/** /**
Adds all available information to the report. Currently this includes a Adds all available information to the report. Currently this includes a
@@ -148,7 +148,7 @@ public:
Add an XML file containing the current or exception context and the Add an XML file containing the current or exception context and the
stack trace. stack trace.
*/ */
bool AddContext(Context ctx); virtual bool AddContext(Context ctx);
/** /**
The same as calling AddContext(Context_Current). The same as calling AddContext(Context_Current).
@@ -188,7 +188,7 @@ public:
@see GetDirectory(), AddText() @see GetDirectory(), AddText()
*/ */
void AddFile(const wxString& filename, const wxString& description); virtual void AddFile(const wxString& filename, const wxString& description);
/** /**
This is a convenient wrapper around AddFile(). It creates the file with This is a convenient wrapper around AddFile(). It creates the file with
@@ -250,7 +250,7 @@ public:
Gets the name used as a base name for various files, by default Gets the name used as a base name for various files, by default
wxApp::GetAppName() is used. wxApp::GetAppName() is used.
*/ */
wxString GetReportName() const; virtual wxString GetReportName() const;
/** /**
Returns @true if the object was successfully initialized. If this Returns @true if the object was successfully initialized. If this

14
interface/wx/dialog.h
View File

@@ -173,7 +173,7 @@ public:
Destructor. Deletes any child windows before deleting the physical Destructor. Deletes any child windows before deleting the physical
window. window.
*/ */
~wxDialog(); virtual ~wxDialog();
/** /**
Adds an identifier to be regarded as a main button for the Adds an identifier to be regarded as a main button for the
@@ -279,7 +279,7 @@ public:
@see ShowModal(), GetReturnCode(), SetReturnCode() @see ShowModal(), GetReturnCode(), SetReturnCode()
*/ */
void EndModal(int retCode); virtual void EndModal(int retCode);
/** /**
Gets the identifier of the button which works like standard OK button Gets the identifier of the button which works like standard OK button
@@ -296,7 +296,7 @@ public:
@ref overview_dialog "layout adaptation code" to know that only the @ref overview_dialog "layout adaptation code" to know that only the
pages need to be made scrollable. pages need to be made scrollable.
*/ */
wxWindow* GetContentWindow() const; virtual wxWindow* GetContentWindow() const;
/** /**
Gets the identifier of the button to map presses of @c ESC button to. Gets the identifier of the button to map presses of @c ESC button to.
@@ -321,7 +321,7 @@ public:
@see @ref overview_dialog_autoscrolling (for more on layout adaptation) @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
*/ */
int GetLayoutAdaptationLevel(); int GetLayoutAdaptationLevel() const;
/** /**
Gets the adaptation mode, overriding the global adaptation flag. Gets the adaptation mode, overriding the global adaptation flag.
@@ -353,7 +353,7 @@ public:
@see SetReturnCode(), ShowModal(), EndModal() @see SetReturnCode(), ShowModal(), EndModal()
*/ */
int GetReturnCode(); int GetReturnCode() const;
/** /**
On PocketPC, a dialog is automatically provided with an empty toolbar. On PocketPC, a dialog is automatically provided with an empty toolbar.
@@ -407,7 +407,7 @@ public:
/** /**
Returns @true if the dialog box is modal, @false otherwise. Returns @true if the dialog box is modal, @false otherwise.
*/ */
bool IsModal() const; virtual bool IsModal() const;
/** /**
The default handler for wxEVT_SYS_COLOUR_CHANGED. The default handler for wxEVT_SYS_COLOUR_CHANGED.
@@ -566,7 +566,7 @@ public:
@see EndModal(), GetReturnCode(), SetReturnCode() @see EndModal(), GetReturnCode(), SetReturnCode()
*/ */
int ShowModal(); virtual int ShowModal();
}; };

4
interface/wx/dialup.h
View File

@@ -43,7 +43,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDialUpManager(); virtual ~wxDialUpManager();
/** /**
Cancel dialing the number initiated with Dial() with async parameter Cancel dialing the number initiated with Dial() with async parameter
@@ -60,7 +60,7 @@ public:
platform-specific class derived from wxDialUpManager. You should delete platform-specific class derived from wxDialUpManager. You should delete
the pointer when you are done with it. the pointer when you are done with it.
*/ */
wxDialUpManager* Create(); static wxDialUpManager* Create();
/** /**
Dial the given ISP, use @a username and @a password to authenticate. Dial the given ISP, use @a username and @a password to authenticate.

2
interface/wx/dir.h
View File

@@ -285,6 +285,6 @@ public:
*/ */
size_t Traverse(wxDirTraverser& sink, size_t Traverse(wxDirTraverser& sink,
const wxString& filespec = wxEmptyString, const wxString& filespec = wxEmptyString,
int flags = wxDIR_DEFAULT); int flags = wxDIR_DEFAULT) const;
}; };

38
interface/wx/dirctrl.h
View File

@@ -75,17 +75,17 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxGenericDirCtrl(); virtual ~wxGenericDirCtrl();
/** /**
Collapse the given @a path. Collapse the given @a path.
*/ */
bool CollapsePath(const wxString& path); virtual bool CollapsePath(const wxString& path);
/** /**
Collapses the entire tree. Collapses the entire tree.
*/ */
void CollapseTree(); virtual void CollapseTree();
/** /**
Create function for two-step construction. See wxGenericDirCtrl() for Create function for two-step construction. See wxGenericDirCtrl() for
@@ -104,86 +104,86 @@ public:
Tries to expand as much of the given @a path as possible, so that the Tries to expand as much of the given @a path as possible, so that the
filename or directory is visible in the tree control. filename or directory is visible in the tree control.
*/ */
bool ExpandPath(const wxString& path); virtual bool ExpandPath(const wxString& path);
/** /**
Gets the default path. Gets the default path.
*/ */
wxString GetDefaultPath() const; virtual wxString GetDefaultPath() const;
/** /**
Gets selected filename path only (else empty string). Gets selected filename path only (else empty string).
This function doesn't count a directory as a selection. This function doesn't count a directory as a selection.
*/ */
wxString GetFilePath() const; virtual wxString GetFilePath() const;
/** /**
Returns the filter string. Returns the filter string.
*/ */
wxString GetFilter() const; virtual wxString GetFilter() const;
/** /**
Returns the current filter index (zero-based). Returns the current filter index (zero-based).
*/ */
int GetFilterIndex() const; virtual int GetFilterIndex() const;
/** /**
Returns a pointer to the filter list control (if present). Returns a pointer to the filter list control (if present).
*/ */
wxDirFilterListCtrl* GetFilterListCtrl() const; virtual wxDirFilterListCtrl* GetFilterListCtrl() const;
/** /**
Gets the currently-selected directory or filename. Gets the currently-selected directory or filename.
*/ */
wxString GetPath() const; virtual wxString GetPath() const;
/** /**
Returns the root id for the tree control. Returns the root id for the tree control.
*/ */
wxTreeItemId GetRootId(); virtual wxTreeItemId GetRootId();
/** /**
Returns a pointer to the tree control. Returns a pointer to the tree control.
*/ */
wxTreeCtrl* GetTreeCtrl() const; virtual wxTreeCtrl* GetTreeCtrl() const;
/** /**
Initializes variables. Initializes variables.
*/ */
void Init(); virtual void Init();
/** /**
Collapse and expand the tree, thus re-creating it from scratch. May be Collapse and expand the tree, thus re-creating it from scratch. May be
used to update the displayed directory content. used to update the displayed directory content.
*/ */
void ReCreateTree(); virtual void ReCreateTree();
/** /**
Sets the default path. Sets the default path.
*/ */
void SetDefaultPath(const wxString& path); virtual void SetDefaultPath(const wxString& path);
/** /**
Sets the filter string. Sets the filter string.
*/ */
void SetFilter(const wxString& filter); virtual void SetFilter(const wxString& filter);
/** /**
Sets the current filter index (zero-based). Sets the current filter index (zero-based).
*/ */
void SetFilterIndex(int n); virtual void SetFilterIndex(int n);
/** /**
Sets the current path. Sets the current path.
*/ */
void SetPath(const wxString& path); virtual void SetPath(const wxString& path);
/** /**
@param show @param show
If @true, hidden folders and files will be displayed by the If @true, hidden folders and files will be displayed by the
control. If @false, they will not be displayed. control. If @false, they will not be displayed.
*/ */
void ShowHidden(bool show); virtual void ShowHidden(bool show);
}; };

10
interface/wx/dirdlg.h
View File

@@ -65,27 +65,27 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDirDialog(); virtual ~wxDirDialog();
/** /**
Returns the message that will be displayed on the dialog. Returns the message that will be displayed on the dialog.
*/ */
wxString GetMessage() const; virtual wxString GetMessage() const;
/** /**
Returns the default or user-selected path. Returns the default or user-selected path.
*/ */
wxString GetPath() const; virtual wxString GetPath() const;
/** /**
Sets the message that will be displayed on the dialog. Sets the message that will be displayed on the dialog.
*/ */
void SetMessage(const wxString& message); virtual void SetMessage(const wxString& message);
/** /**
Sets the default path. Sets the default path.
*/ */
void SetPath(const wxString& path); virtual void SetPath(const wxString& path);
/** /**
Shows the dialog, returning wxID_OK if the user pressed OK, and Shows the dialog, returning wxID_OK if the user pressed OK, and

2
interface/wx/display.h
View File

@@ -122,6 +122,6 @@ public:
Returns @true if the display is the primary display. The primary Returns @true if the display is the primary display. The primary
display is the one whose index is 0. display is the one whose index is 0.
*/ */
bool IsPrimary(); bool IsPrimary() const;
}; };

4
interface/wx/dnd.h
View File

@@ -91,7 +91,7 @@ public:
/** /**
Destructor. Deletes the associated data object, if any. Destructor. Deletes the associated data object, if any.
*/ */
~wxDropTarget(); virtual ~wxDropTarget();
/** /**
This method may only be called from within OnData(). By default, this This method may only be called from within OnData(). By default, this
@@ -228,7 +228,7 @@ public:
/** /**
Default constructor. Default constructor.
*/ */
~wxDropSource(); virtual ~wxDropSource();
/** /**
Starts the drag-and-drop operation which will terminate when the user Starts the drag-and-drop operation which will terminate when the user

4
interface/wx/docmdi.h
View File

@@ -41,7 +41,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDocMDIParentFrame(); virtual ~wxDocMDIParentFrame();
/** /**
Creates the window. Creates the window.
@@ -110,7 +110,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDocMDIChildFrame(); virtual ~wxDocMDIChildFrame();
/** /**
Returns the document associated with this frame. Returns the document associated with this frame.

113
interface/wx/docview.h
View File

@@ -72,7 +72,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDocTemplate(); virtual ~wxDocTemplate();
/** /**
Creates a new instance of the associated document class. If you have Creates a new instance of the associated document class. If you have
@@ -83,73 +83,74 @@ public:
This function calls InitDocument() which in turns calls This function calls InitDocument() which in turns calls
wxDocument::OnCreate(). wxDocument::OnCreate().
*/ */
wxDocument* CreateDocument(const wxString& path, long flags = 0); virtual wxDocument* CreateDocument(const wxString& path, long flags = 0);
/** /**
Creates a new instance of the associated view class. If you have not Creates a new instance of the associated view class. If you have not
supplied a wxClassInfo parameter to the template constructor, you will supplied a wxClassInfo parameter to the template constructor, you will
need to override this function to return an appropriate view instance. need to override this function to return an appropriate view instance.
*/ */
wxView* CreateView(wxDocument* doc, long flags = 0); virtual wxView* CreateView(wxDocument* doc, long flags = 0);
/** /**
Returns the default file extension for the document data, as passed to Returns the default file extension for the document data, as passed to
the document template constructor. the document template constructor.
*/ */
wxString GetDefaultExtension(); wxString GetDefaultExtension() const;
/** /**
Returns the text description of this template, as passed to the Returns the text description of this template, as passed to the
document template constructor. document template constructor.
*/ */
wxString GetDescription(); wxString GetDescription() const;
/** /**
Returns the default directory, as passed to the document template Returns the default directory, as passed to the document template
constructor. constructor.
*/ */
wxString GetDirectory(); wxString GetDirectory() const;
/** /**
Returns a pointer to the document manager instance for which this Returns a pointer to the document manager instance for which this
template was created. template was created.
*/ */
wxDocManager* GetDocumentManager(); wxDocManager* GetDocumentManager() const;
/** /**
Returns the document type name, as passed to the document template Returns the document type name, as passed to the document template
constructor. constructor.
*/ */
wxString GetDocumentName(); virtual wxString GetDocumentName() const;
/** /**
Returns the file filter, as passed to the document template Returns the file filter, as passed to the document template
constructor. constructor.
*/ */
wxString GetFileFilter(); wxString GetFileFilter() const;
/** /**
Returns the flags, as passed to the document template constructor. Returns the flags, as passed to the document template constructor.
*/ */
long GetFlags(); long GetFlags() const;
/** /**
Returns the view type name, as passed to the document template Returns the view type name, as passed to the document template
constructor. constructor.
*/ */
wxString GetViewName(); virtual wxString GetViewName() const;
/** /**
Initialises the document, calling wxDocument::OnCreate(). This is Initialises the document, calling wxDocument::OnCreate(). This is
called from CreateDocument(). called from CreateDocument().
*/ */
bool InitDocument(wxDocument* doc, const wxString& path, long flags = 0); virtual bool InitDocument(wxDocument* doc, const wxString& path,
long flags = 0);
/** /**
Returns @true if the document template can be shown in user dialogs, Returns @true if the document template can be shown in user dialogs,
@false otherwise. @false otherwise.
*/ */
bool IsVisible(); bool IsVisible() const;
/** /**
Sets the default file extension. Sets the default file extension.
@@ -274,12 +275,12 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDocManager(); virtual ~wxDocManager();
/** /**
Sets the current view. Sets the current view.
*/ */
void ActivateView(wxView* doc, bool activate = true); virtual void ActivateView(wxView* doc, bool activate = true);
/** /**
Adds the document to the list of documents. Adds the document to the list of documents.
@@ -290,7 +291,7 @@ public:
Adds a file to the file history list, if we have a pointer to an Adds a file to the file history list, if we have a pointer to an
appropriate file menu. appropriate file menu.
*/ */
void AddFileToHistory(const wxString& filename); virtual void AddFileToHistory(const wxString& filename);
/** /**
Adds the template to the document manager's template list. Adds the template to the document manager's template list.
@@ -338,7 +339,7 @@ public:
file path and type. file path and type.
@return a new document object or @NULL on failure. @return a new document object or @NULL on failure.
*/ */
wxDocument *CreateDocument(const wxString& path, long flags = 0); virtual wxDocument* CreateDocument(const wxString& path, long flags = 0);
/** /**
Creates a new view for the given document. If more than one view is Creates a new view for the given document. If more than one view is
@@ -356,24 +357,24 @@ public:
Appends the files in the history list to all menus managed by the file Appends the files in the history list to all menus managed by the file
history object. history object.
*/ */
void FileHistoryAddFilesToMenu(); virtual void FileHistoryAddFilesToMenu();
/** /**
Appends the files in the history list to the given @a menu only. Appends the files in the history list to the given @a menu only.
*/ */
void FileHistoryAddFilesToMenu(wxMenu* menu); virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
/** /**
Loads the file history from a config object. Loads the file history from a config object.
@see wxConfigBase @see wxConfigBase
*/ */
void FileHistoryLoad(const wxConfigBase& config); virtual void FileHistoryLoad(const wxConfigBase& config);
/** /**
Removes the given menu from the list of menus managed by the file Removes the given menu from the list of menus managed by the file
history object. history object.
*/ */
void FileHistoryRemoveMenu(wxMenu* menu); virtual void FileHistoryRemoveMenu(wxMenu* menu);
/** /**
Saves the file history into a config object. This must be called Saves the file history into a config object. This must be called
@@ -381,7 +382,7 @@ public:
@see wxConfigBase @see wxConfigBase
*/ */
void FileHistorySave(wxConfigBase& resourceFile); virtual void FileHistorySave(wxConfigBase& resourceFile);
/** /**
Use this menu for appending recently-visited document filenames, for Use this menu for appending recently-visited document filenames, for
@@ -391,25 +392,25 @@ public:
@note You can add multiple menus using this function, to be managed by @note You can add multiple menus using this function, to be managed by
the file history object. the file history object.
*/ */
void FileHistoryUseMenu(wxMenu* menu); virtual void FileHistoryUseMenu(wxMenu* menu);
/** /**
Given a path, try to find template that matches the extension. This is Given a path, try to find template that matches the extension. This is
only an approximate method of finding a template for creating a only an approximate method of finding a template for creating a
document. document.
*/ */
wxDocTemplate* FindTemplateForPath(const wxString& path); virtual wxDocTemplate* FindTemplateForPath(const wxString& path);
/** /**
Returns the document associated with the currently active view (if Returns the document associated with the currently active view (if
any). any).
*/ */
wxDocument* GetCurrentDocument(); wxDocument* GetCurrentDocument() const;
/** /**
Returns the currently active view Returns the currently active view
*/ */
wxView* GetCurrentView(); virtual wxView* GetCurrentView() const;
/** /**
Returns a reference to the list of documents. Returns a reference to the list of documents.
@@ -419,12 +420,12 @@ public:
/** /**
Returns a pointer to file history. Returns a pointer to file history.
*/ */
wxFileHistory* GetFileHistory(); virtual wxFileHistory* GetFileHistory() const;
/** /**
Returns the number of files currently stored in the file history. Returns the number of files currently stored in the file history.
*/ */
size_t GetHistoryFilesCount(); virtual size_t GetHistoryFilesCount() const;
/** /**
Returns the directory last selected by the user when opening a file. Returns the directory last selected by the user when opening a file.
@@ -435,7 +436,7 @@ public:
/** /**
Returns the number of documents that can be open simultaneously. Returns the number of documents that can be open simultaneously.
*/ */
int GetMaxDocsOpen(); int GetMaxDocsOpen() const;
/** /**
Returns a reference to the list of associated templates. Returns a reference to the list of associated templates.
@@ -458,7 +459,7 @@ public:
The bottom line: if you're not deriving from Initialize(), forget it The bottom line: if you're not deriving from Initialize(), forget it
and construct wxDocManager with no arguments. and construct wxDocManager with no arguments.
*/ */
bool Initialize(); virtual bool Initialize();
/** /**
Return a string containing a suitable default name for a new document. Return a string containing a suitable default name for a new document.
@@ -466,13 +467,13 @@ public:
string @b unnamed but can be overridden in the derived classes to do string @b unnamed but can be overridden in the derived classes to do
something more appropriate. something more appropriate.
*/ */
wxString MakeNewDocumentName(); virtual wxString MakeNewDocumentName();
/** /**
A hook to allow a derived class to create a different type of file A hook to allow a derived class to create a different type of file
history. Called from Initialize(). history. Called from Initialize().
*/ */
wxFileHistory* OnCreateFileHistory(); virtual wxFileHistory* OnCreateFileHistory();
/** /**
Closes and deletes the currently active document. Closes and deletes the currently active document.
@@ -652,7 +653,7 @@ public:
/** /**
Destructor. Removes itself from the document's list of views. Destructor. Removes itself from the document's list of views.
*/ */
~wxView(); virtual ~wxView();
/** /**
Call this from your view frame's wxDocChildFrame::OnActivate() member Call this from your view frame's wxDocChildFrame::OnActivate() member
@@ -691,7 +692,7 @@ public:
uses notebook pages instead of frames and this is why this method uses notebook pages instead of frames and this is why this method
returns a wxWindow and not a wxFrame. returns a wxWindow and not a wxFrame.
*/ */
wxWindow* GetFrame(); wxWindow* GetFrame() const;
/** /**
Gets the name associated with the view (passed to the wxDocTemplate Gets the name associated with the view (passed to the wxDocTemplate
@@ -777,7 +778,7 @@ public:
Associates the given document with the view. Normally called by the Associates the given document with the view. Normally called by the
framework. framework.
*/ */
void SetDocument(wxDocument* doc); virtual void SetDocument(wxDocument* doc);
/** /**
Sets the frame associated with this view. The application should call Sets the frame associated with this view. The application should call
@@ -847,7 +848,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDocChildFrame(); virtual ~wxDocChildFrame();
/** /**
Returns the document associated with this frame. Returns the document associated with this frame.
@@ -929,7 +930,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxDocParentFrame(); virtual ~wxDocParentFrame();
/** /**
Used in two-step construction. Used in two-step construction.
@@ -993,7 +994,7 @@ public:
/** /**
Destructor. Removes itself from the document manager. Destructor. Removes itself from the document manager.
*/ */
~wxDocument(); virtual ~wxDocument();
/** /**
If the view is not already in the list of views, adds the view and If the view is not already in the list of views, adds the view and
@@ -1023,12 +1024,12 @@ public:
@see wxCommandProcessor @see wxCommandProcessor
*/ */
wxCommandProcessor* GetCommandProcessor() const; virtual wxCommandProcessor* GetCommandProcessor() const;
/** /**
Gets a pointer to the associated document manager. Gets a pointer to the associated document manager.
*/ */
wxDocManager* GetDocumentManager() const; virtual wxDocManager* GetDocumentManager() const;
/** /**
Gets the document type name for this document. See the comment for Gets the document type name for this document. See the comment for
@@ -1039,14 +1040,14 @@ public:
/** /**
Gets a pointer to the template that created the document. Gets a pointer to the template that created the document.
*/ */
wxDocTemplate* GetDocumentTemplate() const; virtual wxDocTemplate* GetDocumentTemplate() const;
/** /**
Intended to return a suitable window for using as a parent for Intended to return a suitable window for using as a parent for
document-related dialog boxes. By default, uses the frame associated document-related dialog boxes. By default, uses the frame associated
with the first view. with the first view.
*/ */
wxWindow* GetDocumentWindow() const; virtual wxWindow* GetDocumentWindow() const;
/** /**
Gets the filename associated with this document, or "" if none is Gets the filename associated with this document, or "" if none is
@@ -1235,7 +1236,7 @@ public:
Sets the pointer to the template that created the document. Should only Sets the pointer to the template that created the document. Should only
be called by the framework. be called by the framework.
*/ */
void SetDocumentTemplate(wxDocTemplate* templ); virtual void SetDocumentTemplate(wxDocTemplate* templ);
/** /**
Sets the filename for this document. Usually called by the framework. Sets the filename for this document. Usually called by the framework.
@@ -1257,7 +1258,7 @@ public:
view. @a hint represents optional information to allow a view to view. @a hint represents optional information to allow a view to
optimize its update. optimize its update.
*/ */
void UpdateAllViews(wxView* sender = NULL, wxObject* hint = NULL); virtual void UpdateAllViews(wxView* sender = NULL, wxObject* hint = NULL);
protected: protected:
/** /**
@@ -1356,23 +1357,23 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxFileHistory(); virtual ~wxFileHistory();
/** /**
Adds a file to the file history list, if the object has a pointer to an Adds a file to the file history list, if the object has a pointer to an
appropriate file menu. appropriate file menu.
*/ */
void AddFileToHistory(const wxString& filename); virtual void AddFileToHistory(const wxString& filename);
/** /**
Appends the files in the history list, to all menus managed by the file Appends the files in the history list, to all menus managed by the file
history object. history object.
*/ */
void AddFilesToMenu(); virtual void AddFilesToMenu();
/** /**
Appends the files in the history list, to the given menu only. Appends the files in the history list, to the given menu only.
*/ */
void AddFilesToMenu(wxMenu* menu); virtual void AddFilesToMenu(wxMenu* menu);
/** /**
Returns the base identifier for the range used for appending items. Returns the base identifier for the range used for appending items.
@@ -1382,17 +1383,17 @@ public:
/** /**
Returns the number of files currently stored in the file history. Returns the number of files currently stored in the file history.
*/ */
size_t GetCount() const; virtual size_t GetCount() const;
/** /**
Returns the file at this index (zero-based). Returns the file at this index (zero-based).
*/ */
wxString GetHistoryFile(size_t index) const; virtual wxString GetHistoryFile(size_t index) const;
/** /**
Returns the maximum number of files that can be stored. Returns the maximum number of files that can be stored.
*/ */
int GetMaxFiles() const; virtual int GetMaxFiles() const;
/** /**
Returns the list of menus that are managed by this file history object. Returns the list of menus that are managed by this file history object.
@@ -1407,17 +1408,17 @@ public:
@see wxConfigBase @see wxConfigBase
*/ */
void Load(const wxConfigBase& config); virtual void Load(const wxConfigBase& config);
/** /**
Removes the specified file from the history. Removes the specified file from the history.
*/ */
void RemoveFileFromHistory(size_t i); virtual void RemoveFileFromHistory(size_t i);
/** /**
Removes this menu from the list of those managed by this object. Removes this menu from the list of those managed by this object.
*/ */
void RemoveMenu(wxMenu* menu); virtual void RemoveMenu(wxMenu* menu);
/** /**
Saves the file history into the given config object. This must be Saves the file history into the given config object. This must be
@@ -1425,7 +1426,7 @@ public:
@see wxConfigBase @see wxConfigBase
*/ */
void Save(wxConfigBase& config); virtual void Save(wxConfigBase& config);
/** /**
Sets the base identifier for the range used for appending items. Sets the base identifier for the range used for appending items.
@@ -1438,7 +1439,7 @@ public:
with filenames that are already in the history when this function is with filenames that are already in the history when this function is
called, as this is not done automatically. called, as this is not done automatically.
*/ */
void UseMenu(wxMenu* menu); virtual void UseMenu(wxMenu* menu);
/** /**
A character array of strings corresponding to the most recently opened A character array of strings corresponding to the most recently opened

8
interface/wx/dragimag.h
View File

@@ -192,7 +192,7 @@ public:
applications to draw their own image instead of using an actual bitmap. applications to draw their own image instead of using an actual bitmap.
If you override this function, you must also override GetImageRect(). If you override this function, you must also override GetImageRect().
*/ */
virtual bool DoDrawImage(wxDC& dc, const wxPoint& pos); virtual bool DoDrawImage(wxDC& dc, const wxPoint& pos) const;
/** /**
Call this when the drag has finished. Call this when the drag has finished.
@@ -254,8 +254,8 @@ public:
This function is available in wxGenericDragImage only. This function is available in wxGenericDragImage only.
*/ */
bool UpdateBackingFromWindow(wxDC& windowDC, wxMemoryDC& destDC, virtual bool UpdateBackingFromWindow(wxDC& windowDC, wxMemoryDC& destDC,
const wxRect& sourceRect, const wxRect& sourceRect,
const wxRect& destRect) const; const wxRect& destRect) const;
}; };

2
interface/wx/editlbox.h
View File

@@ -71,7 +71,7 @@ public:
/** /**
Destructor, destroying the list box. Destructor, destroying the list box.
*/ */
~wxEditableListBox(); virtual ~wxEditableListBox();
/** /**
Creates the editable listbox for two-step construction. Creates the editable listbox for two-step construction.

2
interface/wx/fdrepdlg.h
View File

@@ -189,7 +189,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxFindReplaceDialog(); virtual ~wxFindReplaceDialog();
/** /**
Creates the dialog; use wxWindow::Show to show it on screen. Creates the dialog; use wxWindow::Show to show it on screen.

22
interface/wx/filectrl.h
View File

@@ -105,14 +105,14 @@ public:
/** /**
Returns the current directory of the file control (i.e. the directory shown by it). Returns the current directory of the file control (i.e. the directory shown by it).
*/ */
wxString GetDirectory() const; virtual wxString GetDirectory() const;
/** /**
Returns the currently selected filename. Returns the currently selected filename.
For the controls having the @c wxFC_MULTIPLE style, use GetFilenames() instead. For the controls having the @c wxFC_MULTIPLE style, use GetFilenames() instead.
*/ */
wxString GetFilename() const; virtual wxString GetFilename() const;
/** /**
Fills the array @a filenames with the filenames only of selected items. Fills the array @a filenames with the filenames only of selected items.
@@ -122,18 +122,18 @@ public:
@remarks filenames is emptied first. @remarks filenames is emptied first.
*/ */
void GetFilenames(wxArrayString& filenames) const; virtual void GetFilenames(wxArrayString& filenames) const;
/** /**
Returns the zero-based index of the currently selected filter. Returns the zero-based index of the currently selected filter.
*/ */
int GetFilterIndex() const; virtual int GetFilterIndex() const;
/** /**
Returns the full path (directory and filename) of the currently selected file. Returns the full path (directory and filename) of the currently selected file.
For the controls having the @c wxFC_MULTIPLE style, use GetPaths() instead. For the controls having the @c wxFC_MULTIPLE style, use GetPaths() instead.
*/ */
wxString GetPath() const; virtual wxString GetPath() const;
/** /**
Fills the array @a paths with the full paths of the files chosen. Fills the array @a paths with the full paths of the files chosen.
@@ -143,37 +143,37 @@ public:
@remarks paths is emptied first. @remarks paths is emptied first.
*/ */
void GetPaths(wxArrayString& paths) const; virtual void GetPaths(wxArrayString& paths) const;
/** /**
Returns the current wildcard. Returns the current wildcard.
*/ */
wxString GetWildcard() const; virtual wxString GetWildcard() const;
/** /**
Sets(changes) the current directory displayed in the control. Sets(changes) the current directory displayed in the control.
@return Returns @true on success, @false otherwise. @return Returns @true on success, @false otherwise.
*/ */
bool SetDirectory(const wxString& directory); virtual bool SetDirectory(const wxString& directory);
/** /**
Selects a certain file. Selects a certain file.
@return Returns @true on success, @false otherwise @return Returns @true on success, @false otherwise
*/ */
bool SetFilename(const wxString& filename); virtual bool SetFilename(const wxString& filename);
/** /**
Sets the current filter index, starting from zero. Sets the current filter index, starting from zero.
*/ */
void SetFilterIndex(int filterIndex); virtual void SetFilterIndex(int filterIndex);
/** /**
Sets the wildcard, which can contain multiple file types, for example: Sets the wildcard, which can contain multiple file types, for example:
"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
*/ */
void SetWildcard(const wxString& wildCard); virtual void SetWildcard(const wxString& wildCard);
/** /**
Sets whether hidden files and folders are shown or not. Sets whether hidden files and folders are shown or not.

32
interface/wx/filedlg.h
View File

@@ -102,12 +102,12 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxFileDialog(); virtual ~wxFileDialog();
/** /**
Returns the default directory. Returns the default directory.
*/ */
wxString GetDirectory() const; virtual wxString GetDirectory() const;
/** /**
If functions SetExtraControlCreator() and ShowModal() were called, If functions SetExtraControlCreator() and ShowModal() were called,
@@ -118,7 +118,7 @@ public:
/** /**
Returns the default filename. Returns the default filename.
*/ */
wxString GetFilename() const; virtual wxString GetFilename() const;
/** /**
Fills the array @a filenames with the names of the files chosen. Fills the array @a filenames with the names of the files chosen.
@@ -131,7 +131,7 @@ public:
of each referenced file by appending the directory containing the shortcuts of each referenced file by appending the directory containing the shortcuts
to the filename. to the filename.
*/ */
void GetFilenames(wxArrayString& filenames) const; virtual void GetFilenames(wxArrayString& filenames) const;
/** /**
Returns the index into the list of filters supplied, optionally, in the Returns the index into the list of filters supplied, optionally, in the
@@ -142,17 +142,17 @@ public:
After the dialog is shown, this is the index selected by the user. After the dialog is shown, this is the index selected by the user.
*/ */
int GetFilterIndex() const; virtual int GetFilterIndex() const;
/** /**
Returns the message that will be displayed on the dialog. Returns the message that will be displayed on the dialog.
*/ */
wxString GetMessage() const; virtual wxString GetMessage() const;
/** /**
Returns the full path (directory and filename) of the selected file. Returns the full path (directory and filename) of the selected file.
*/ */
wxString GetPath() const; virtual wxString GetPath() const;
/** /**
Fills the array @a paths with the full paths of the files chosen. Fills the array @a paths with the full paths of the files chosen.
@@ -160,17 +160,17 @@ public:
This function should only be used with the dialogs which have @c wxFD_MULTIPLE style, This function should only be used with the dialogs which have @c wxFD_MULTIPLE style,
use GetPath() for the others. use GetPath() for the others.
*/ */
void GetPaths(wxArrayString& paths) const; virtual void GetPaths(wxArrayString& paths) const;
/** /**
Returns the file dialog wildcard. Returns the file dialog wildcard.
*/ */
wxString GetWildcard() const; virtual wxString GetWildcard() const;
/** /**
Sets the default directory. Sets the default directory.
*/ */
void SetDirectory(const wxString& directory); virtual void SetDirectory(const wxString& directory);
/** /**
Customize file dialog by adding extra window, which is typically placed Customize file dialog by adding extra window, which is typically placed
@@ -188,23 +188,23 @@ public:
/** /**
Sets the default filename. Sets the default filename.
*/ */
void SetFilename(const wxString& setfilename); virtual void SetFilename(const wxString& setfilename);
/** /**
Sets the default filter index, starting from zero. Sets the default filter index, starting from zero.
*/ */
void SetFilterIndex(int filterIndex); virtual void SetFilterIndex(int filterIndex);
/** /**
Sets the message that will be displayed on the dialog. Sets the message that will be displayed on the dialog.
*/ */
void SetMessage(const wxString& message); virtual void SetMessage(const wxString& message);
/** /**
Sets the path (the combined directory and filename that will be returned when Sets the path (the combined directory and filename that will be returned when
the dialog is dismissed). the dialog is dismissed).
*/ */
void SetPath(const wxString& path); virtual void SetPath(const wxString& path);
/** /**
Sets the wildcard, which can contain multiple file types, for example: Sets the wildcard, which can contain multiple file types, for example:
@@ -213,13 +213,13 @@ public:
Note that the native Motif dialog has some limitations with respect to Note that the native Motif dialog has some limitations with respect to
wildcards; see the Remarks section above. wildcards; see the Remarks section above.
*/ */
void SetWildcard(const wxString& wildCard); virtual void SetWildcard(const wxString& wildCard);
/** /**
Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
otherwise. otherwise.
*/ */
int ShowModal(); virtual int ShowModal();
}; };

2
interface/wx/filename.h
View File

@@ -580,7 +580,7 @@ public:
not be read (because e.g. the file is locked by another process) the returned not be read (because e.g. the file is locked by another process) the returned
value is ::wxInvalidSize. value is ::wxInvalidSize.
*/ */
wxULongLong GetSize(); wxULongLong GetSize() const;
/** /**
Returns the size of the file If the file does not exist or its size could Returns the size of the file If the file does not exist or its size could

4
interface/wx/filesys.h
View File

@@ -131,7 +131,7 @@ public:
/** /**
Returns the actual path (set by wxFileSystem::ChangePathTo). Returns the actual path (set by wxFileSystem::ChangePathTo).
*/ */
wxString GetPath(); wxString GetPath() const;
/** /**
This static function returns @true if there is a registered handler which can This static function returns @true if there is a registered handler which can
@@ -409,7 +409,7 @@ public:
GetMimeTypeFromExt("index.htm") == "text/html" GetMimeTypeFromExt("index.htm") == "text/html"
@endcode @endcode
*/ */
wxString GetMimeTypeFromExt(const wxString& location); static wxString GetMimeTypeFromExt(const wxString& location);
/** /**
Returns the protocol string extracted from @a location. Returns the protocol string extracted from @a location.

16
interface/wx/font.h
View File

@@ -378,7 +378,7 @@ public:
pointer to the font object is stored in an application pointer to the font object is stored in an application
data structure, and there is a risk of double deletion. data structure, and there is a risk of double deletion.
*/ */
~wxFont(); virtual ~wxFont();
/** /**
Returns the current application's default encoding. Returns the current application's default encoding.
@@ -393,7 +393,7 @@ public:
@see SetFaceName() @see SetFaceName()
*/ */
wxString GetFaceName() const; virtual wxString GetFaceName() const;
/** /**
Gets the font family. See SetFamily() for a list of valid Gets the font family. See SetFamily() for a list of valid
@@ -423,14 +423,14 @@ public:
@see GetNativeFontInfoDesc() @see GetNativeFontInfoDesc()
*/ */
wxString GetNativeFontInfoUserDesc(); wxString GetNativeFontInfoUserDesc() const;
/** /**
Gets the point size. Gets the point size.
@see SetPointSize() @see SetPointSize()
*/ */
int GetPointSize() const; virtual int GetPointSize() const;
/** /**
Gets the font style. See wxFontStyle for a list of valid styles. Gets the font style. See wxFontStyle for a list of valid styles.
@@ -444,7 +444,7 @@ public:
@see SetUnderlined() @see SetUnderlined()
*/ */
bool GetUnderlined() const; virtual bool GetUnderlined() const;
/** /**
Gets the font weight. See wxFontWeight for a list of valid weight identifiers. Gets the font weight. See wxFontWeight for a list of valid weight identifiers.
@@ -457,7 +457,7 @@ public:
Returns @true if the font is a fixed width (or monospaced) font, Returns @true if the font is a fixed width (or monospaced) font,
@false if it is a proportional one or font is invalid. @false if it is a proportional one or font is invalid.
*/ */
bool IsFixedWidth() const; virtual bool IsFixedWidth() const;
/** /**
Returns @true if this object is a valid font, @false otherwise. Returns @true if this object is a valid font, @false otherwise.
@@ -519,7 +519,7 @@ public:
@see GetFaceName(), SetFamily() @see GetFaceName(), SetFamily()
*/ */
bool SetFaceName(const wxString& faceName); virtual bool SetFaceName(const wxString& faceName);
/** /**
Sets the font family. Sets the font family.
@@ -576,7 +576,7 @@ public:
@see GetPointSize() @see GetPointSize()
*/ */
void SetPointSize(int pointSize); virtual void SetPointSize(int pointSize);
/** /**
Sets the font style. Sets the font style.

18
interface/wx/frame.h
View File

@@ -161,7 +161,7 @@ public:
/** /**
Destructor. Destroys all child windows and menu bar if present. Destructor. Destroys all child windows and menu bar if present.
*/ */
~wxFrame(); virtual ~wxFrame();
/** /**
Centres the frame on the display. Centres the frame on the display.
@@ -248,14 +248,14 @@ public:
Returns the origin of the frame client area (in client coordinates). Returns the origin of the frame client area (in client coordinates).
It may be different from (0, 0) if the frame has a toolbar. It may be different from (0, 0) if the frame has a toolbar.
*/ */
wxPoint GetClientAreaOrigin() const; virtual wxPoint GetClientAreaOrigin() const;
/** /**
Returns a pointer to the menubar currently associated with the frame (if any). Returns a pointer to the menubar currently associated with the frame (if any).
@see SetMenuBar(), wxMenuBar, wxMenu @see SetMenuBar(), wxMenuBar, wxMenu
*/ */
wxMenuBar* GetMenuBar() const; virtual wxMenuBar* GetMenuBar() const;
/** /**
Returns a pointer to the status bar currently associated with the frame Returns a pointer to the status bar currently associated with the frame
@@ -263,21 +263,21 @@ public:
@see CreateStatusBar(), wxStatusBar @see CreateStatusBar(), wxStatusBar
*/ */
wxStatusBar* GetStatusBar() const; virtual wxStatusBar* GetStatusBar() const;
/** /**
Returns the status bar pane used to display menu and toolbar help. Returns the status bar pane used to display menu and toolbar help.
@see SetStatusBarPane() @see SetStatusBarPane()
*/ */
int GetStatusBarPane(); int GetStatusBarPane() const;
/** /**
Returns a pointer to the toolbar currently associated with the frame (if any). Returns a pointer to the toolbar currently associated with the frame (if any).
@see CreateToolBar(), wxToolBar, SetToolBar() @see CreateToolBar(), wxToolBar, SetToolBar()
*/ */
wxToolBar* GetToolBar() const; virtual wxToolBar* GetToolBar() const;
/** /**
Virtual function called when a status bar is requested by CreateStatusBar(). Virtual function called when a status bar is requested by CreateStatusBar().
@@ -353,14 +353,14 @@ public:
@see GetMenuBar(), wxMenuBar, wxMenu. @see GetMenuBar(), wxMenuBar, wxMenu.
*/ */
void SetMenuBar(wxMenuBar* menuBar); virtual void SetMenuBar(wxMenuBar* menuBar);
/** /**
Associates a status bar with the frame. Associates a status bar with the frame.
@see CreateStatusBar(), wxStatusBar, GetStatusBar() @see CreateStatusBar(), wxStatusBar, GetStatusBar()
*/ */
void SetStatusBar(wxStatusBar* statusBar); virtual void SetStatusBar(wxStatusBar* statusBar);
/** /**
Set the status bar pane used to display menu and toolbar help. Set the status bar pane used to display menu and toolbar help.
@@ -403,6 +403,6 @@ public:
/** /**
Associates a toolbar with the frame. Associates a toolbar with the frame.
*/ */
void SetToolBar(wxToolBar* toolBar); virtual void SetToolBar(wxToolBar* toolBar);
}; };

4
interface/wx/gauge.h
View File

@@ -79,7 +79,7 @@ public:
/** /**
Destructor, destroying the gauge. Destructor, destroying the gauge.
*/ */
~wxGauge(); virtual ~wxGauge();
/** /**
Creates the gauge for two-step construction. See wxGauge() for further Creates the gauge for two-step construction. See wxGauge() for further
@@ -138,7 +138,7 @@ public:
undefined and thus you need to explicitely call SetValue() if you undefined and thus you need to explicitely call SetValue() if you
want to restore the determinate mode. want to restore the determinate mode.
*/ */
void Pulse(); virtual void Pulse();
/** /**
Sets the 3D bezel face width. Sets the 3D bezel face width.

2
interface/wx/gdicmn.h
View File

@@ -612,7 +612,7 @@ public:
is, wxColour::IsOk() will return @false) if the colour wasn't found in is, wxColour::IsOk() will return @false) if the colour wasn't found in
the database. the database.
*/ */
wxColour Find(const wxString& colourName); wxColour Find(const wxString& colourName) const;
/** /**
Finds a colour name given the colour. Returns an empty string if the Finds a colour name given the colour. Returns an empty string if the

2
interface/wx/generic/spinctrg.h
View File

@@ -128,7 +128,7 @@ public:
/** /**
Sets the value of the spin control. Use the variant using double instead. Sets the value of the spin control. Use the variant using double instead.
*/ */
void SetValue(const wxString& text); virtual void SetValue(const wxString& text);
/** /**
Sets the value of the spin control. Sets the value of the spin control.

34
interface/wx/grid.h
View File

@@ -41,7 +41,7 @@ public:
/** /**
Parameters string format is "width[,precision]". Parameters string format is "width[,precision]".
*/ */
void SetParameters(const wxString& params); virtual void SetParameters(const wxString& params);
/** /**
Sets the precision. Sets the precision.
@@ -492,7 +492,7 @@ public:
/** /**
Final cleanup. Final cleanup.
*/ */
void Destroy(); virtual void Destroy();
/** /**
Complete the editing of the current cell. Returns @true if the value has Complete the editing of the current cell. Returns @true if the value has
@@ -504,7 +504,7 @@ public:
Some types of controls on some platforms may need some help Some types of controls on some platforms may need some help
with the Return key. with the Return key.
*/ */
void HandleReturn(wxKeyEvent& event); virtual void HandleReturn(wxKeyEvent& event);
/** /**
@@ -526,26 +526,26 @@ public:
/** /**
Size and position the edit control. Size and position the edit control.
*/ */
void SetSize(const wxRect& rect); virtual void SetSize(const wxRect& rect);
/** /**
Show or hide the edit control, use the specified attributes to set Show or hide the edit control, use the specified attributes to set
colours/fonts for it. colours/fonts for it.
*/ */
void Show(bool show, wxGridCellAttr* attr = NULL); virtual void Show(bool show, wxGridCellAttr* attr = NULL);
/** /**
If the editor is enabled by clicking on the cell, this method will be If the editor is enabled by clicking on the cell, this method will be
called. called.
*/ */
void StartingClick(); virtual void StartingClick();
/** /**
If the editor is enabled by pressing keys on the grid, If the editor is enabled by pressing keys on the grid,
this will be called to let the editor do something about this will be called to let the editor do something about
that first key if desired. that first key if desired.
*/ */
void StartingKey(wxKeyEvent& event); virtual void StartingKey(wxKeyEvent& event);
}; };
@@ -573,7 +573,7 @@ public:
The parameters string format is "n" where n is a number representing the The parameters string format is "n" where n is a number representing the
maximum width. maximum width.
*/ */
void SetParameters(const wxString& params); virtual void SetParameters(const wxString& params);
}; };
@@ -634,7 +634,7 @@ public:
/** /**
Parameters string format is "item1[,item2[...,itemN]]" Parameters string format is "item1[,item2[...,itemN]]"
*/ */
void SetParameters(const wxString& params); virtual void SetParameters(const wxString& params);
}; };
@@ -857,7 +857,7 @@ public:
/** /**
Parameters string format is "min,max". Parameters string format is "min,max".
*/ */
void SetParameters(const wxString& params); virtual void SetParameters(const wxString& params);
}; };
@@ -1156,7 +1156,7 @@ public:
/** /**
Column at which the event occurred. Column at which the event occurred.
*/ */
int GetCol(); virtual int GetCol();
/** /**
Position in pixels at which the event occurred. Position in pixels at which the event occurred.
@@ -1166,7 +1166,7 @@ public:
/** /**
Row at which the event occurred. Row at which the event occurred.
*/ */
int GetRow(); virtual int GetRow();
/** /**
Returns @true if the Meta key was down at the time of the event. Returns @true if the Meta key was down at the time of the event.
@@ -1212,7 +1212,7 @@ public:
/** /**
Parameters string format is "width,precision" Parameters string format is "width,precision"
*/ */
void SetParameters(const wxString& params); virtual void SetParameters(const wxString& params);
}; };
@@ -1655,7 +1655,7 @@ public:
without (yet) matching calls to EndBatch(). While without (yet) matching calls to EndBatch(). While
the grid's batch count is greater than zero the display will not be updated. the grid's batch count is greater than zero the display will not be updated.
*/ */
int GetBatchCount() const; int GetBatchCount();
/** /**
Sets the arguments to the horizontal and vertical text alignment values Sets the arguments to the horizontal and vertical text alignment values
@@ -1737,7 +1737,7 @@ public:
See GetRowGridLinePen() for an example. See GetRowGridLinePen() for an example.
*/ */
wxPen GetColGridLinePen(int col); virtual wxPen GetColGridLinePen(int col);
/** /**
Sets the arguments to the current column label alignment values. Sets the arguments to the current column label alignment values.
@@ -1887,7 +1887,7 @@ public:
@see GetColGridLinePen(), GetRowGridLinePen() @see GetColGridLinePen(), GetRowGridLinePen()
*/ */
wxPen GetDefaultGridLinePen(); virtual wxPen GetDefaultGridLinePen();
/** /**
Returns a pointer to the current default grid cell renderer. Returns a pointer to the current default grid cell renderer.
@@ -2006,7 +2006,7 @@ public:
} }
@endcode @endcode
*/ */
wxPen GetRowGridLinePen(int row); virtual wxPen GetRowGridLinePen(int row);
/** /**
Returns the alignment used for row labels. Returns the alignment used for row labels.

4
interface/wx/hash.h
View File

@@ -33,7 +33,7 @@ public:
/** /**
Destroys the hash table. Destroys the hash table.
*/ */
~wxHashTable(); virtual ~wxHashTable();
/** /**
The counterpart of @e Next. If the application wishes to iterate The counterpart of @e Next. If the application wishes to iterate
@@ -80,7 +80,7 @@ public:
Makes an integer key out of a string. An application may wish to make a key Makes an integer key out of a string. An application may wish to make a key
explicitly (for instance when combining two data values to form a key). explicitly (for instance when combining two data values to form a key).
*/ */
long MakeKey(const wxString& string); static long MakeKey(const wxString& string);
/** /**
If the application wishes to iterate through all the data in the hash If the application wishes to iterate through all the data in the hash

16
interface/wx/html/htmlcell.h
View File

@@ -170,7 +170,7 @@ public:
@param param @param param
Optional parameters Optional parameters
*/ */
virtual const wxHtmlCell* Find(int condition, const void* param); virtual const wxHtmlCell* Find(int condition, const void* param) const;
/** /**
Returns descent value of the cell (m_Descent member). Returns descent value of the cell (m_Descent member).
@@ -186,7 +186,7 @@ public:
finding particular cell in the list, try Find() method finding particular cell in the list, try Find() method
instead. instead.
*/ */
wxHtmlCell* GetFirstChild(); virtual wxHtmlCell* GetFirstChild() const;
/** /**
Returns height of the cell (m_Height member). Returns height of the cell (m_Height member).
@@ -216,7 +216,7 @@ public:
@param window @param window
interface to the parent HTML window interface to the parent HTML window
*/ */
virtual wxCursor GetMouseCursor(wxHtmlWindowInterface* window); virtual wxCursor GetMouseCursor(wxHtmlWindowInterface* window) const;
/** /**
Returns pointer to the next cell in list (see htmlcell.h if you're Returns pointer to the next cell in list (see htmlcell.h if you're
@@ -306,7 +306,7 @@ public:
/** /**
Sets the cell's position within parent container. Sets the cell's position within parent container.
*/ */
void SetPos(int x, int y); virtual void SetPos(int x, int y);
}; };
@@ -703,25 +703,25 @@ public:
only within wxHtmlWindow::OnLinkClicked, only within wxHtmlWindow::OnLinkClicked,
@NULL otherwise. @NULL otherwise.
*/ */
const wxMouseEvent* GetEvent(); const wxMouseEvent* GetEvent() const;
/** /**
Return @e HREF value of the @c A tag. Return @e HREF value of the @c A tag.
*/ */
wxString GetHref(); wxString GetHref() const;
/** /**
Return pointer to the cell that was clicked. Valid Return pointer to the cell that was clicked. Valid
only within wxHtmlWindow::OnLinkClicked, only within wxHtmlWindow::OnLinkClicked,
@NULL otherwise. @NULL otherwise.
*/ */
const wxHtmlCell* GetHtmlCell(); const wxHtmlCell* GetHtmlCell() const;
/** /**
Return @e TARGET value of the @c A tag (this value Return @e TARGET value of the @c A tag (this value
is used to specify in which frame should be the page pointed is used to specify in which frame should be the page pointed
by @ref gethref() Href opened). by @ref gethref() Href opened).
*/ */
wxString GetTarget(); wxString GetTarget() const;
}; };

2
interface/wx/html/htmlpars.h
View File

@@ -263,6 +263,6 @@ public:
Parse() or any function called Parse() or any function called
by it (i.e. from tag handlers). by it (i.e. from tag handlers).
*/ */
void StopParsing(); virtual void StopParsing();
}; };

1
interface/wx/html/htmltag.h
View File

@@ -38,6 +38,7 @@ public:
Returns beginning position of the text @e between this tag and paired Returns beginning position of the text @e between this tag and paired
ending tag. ending tag.
See explanation (returned position is marked with '|'): See explanation (returned position is marked with '|'):
@deprecated @todo provide deprecation description
*/ */
int GetBeginPos() const; int GetBeginPos() const;

14
interface/wx/html/htmlwin.h
View File

@@ -88,20 +88,20 @@ public:
If no page is opened or if the displayed page wasn't If no page is opened or if the displayed page wasn't
produced by call to LoadPage, empty string is returned. produced by call to LoadPage, empty string is returned.
*/ */
wxString GetOpenedAnchor(); wxString GetOpenedAnchor() const;
/** /**
Returns full location of the opened page. If no page is opened or if the Returns full location of the opened page. If no page is opened or if the
displayed page wasn't displayed page wasn't
produced by call to LoadPage, empty string is returned. produced by call to LoadPage, empty string is returned.
*/ */
wxString GetOpenedPage(); wxString GetOpenedPage() const;
/** /**
Returns title of the opened page or wxEmptyString if current page does not Returns title of the opened page or wxEmptyString if current page does not
contain @c TITLE tag. contain @c TITLE tag.
*/ */
wxString GetOpenedPageTitle(); wxString GetOpenedPageTitle() const;
/** /**
Returns the related frame. Returns the related frame.
@@ -143,7 +143,7 @@ public:
@see LoadPage() @see LoadPage()
*/ */
virtual bool LoadFile(const wxFileName& filename); bool LoadFile(const wxFileName& filename);
/** /**
Unlike SetPage this function first loads HTML page from @a location Unlike SetPage this function first loads HTML page from @a location
@@ -256,8 +256,8 @@ public:
URL if OnOpeningURL returns wxHTML_REDIRECT. URL if OnOpeningURL returns wxHTML_REDIRECT.
*/ */
virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type, virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type,
const wxString& url, const wxString& url,
wxString* redirect); wxString* redirect) const;
/** /**
Called on parsing @c TITLE tag. Called on parsing @c TITLE tag.
@@ -352,7 +352,7 @@ public:
@return @false if an error occurred, @true otherwise. @return @false if an error occurred, @true otherwise.
*/ */
bool SetPage(const wxString& source); virtual bool SetPage(const wxString& source);
/** /**
Sets the frame in which page title will be displayed. @a format is format of Sets the frame in which page title will be displayed. @a format is format of

4
interface/wx/htmllbox.h
View File

@@ -40,7 +40,7 @@ public:
/** /**
Destructor cleans up whatever resources we use. Destructor cleans up whatever resources we use.
*/ */
~wxHtmlListBox(); virtual ~wxHtmlListBox();
/** /**
Creates the control and optionally sets the initial number of items in it Creates the control and optionally sets the initial number of items in it
@@ -211,7 +211,7 @@ public:
/** /**
Frees the array of stored items and relative client data. Frees the array of stored items and relative client data.
*/ */
~wxSimpleHtmlListBox(); virtual ~wxSimpleHtmlListBox();
//@{ //@{
/** /**

16
interface/wx/hyperlink.h
View File

@@ -123,19 +123,19 @@ public:
Returns the colour used to print the label of the hyperlink when the mouse is Returns the colour used to print the label of the hyperlink when the mouse is
over the control. over the control.
*/ */
wxColour GetHoverColour() const; virtual wxColour GetHoverColour() const;
/** /**
Returns the colour used to print the label when the link has never been clicked Returns the colour used to print the label when the link has never been clicked
before before
(i.e. the link has not been @e visited) and the mouse is not over the control. (i.e. the link has not been @e visited) and the mouse is not over the control.
*/ */
wxColour GetNormalColour() const; virtual wxColour GetNormalColour() const;
/** /**
Returns the URL associated with the hyperlink. Returns the URL associated with the hyperlink.
*/ */
wxString GetURL() const; virtual wxString GetURL() const;
/** /**
Returns @true if the hyperlink has already been clicked by the user at least Returns @true if the hyperlink has already been clicked by the user at least
@@ -149,25 +149,25 @@ public:
and the link has already been clicked before (i.e. the link has been @e and the link has already been clicked before (i.e. the link has been @e
visited). visited).
*/ */
wxColour GetVisitedColour() const; virtual wxColour GetVisitedColour() const;
/** /**
Sets the colour used to print the label of the hyperlink when the mouse is over Sets the colour used to print the label of the hyperlink when the mouse is over
the control. the control.
*/ */
void SetHoverColour(const wxColour& colour); virtual void SetHoverColour(const wxColour& colour);
/** /**
Sets the colour used to print the label when the link has never been clicked Sets the colour used to print the label when the link has never been clicked
before before
(i.e. the link has not been @e visited) and the mouse is not over the control. (i.e. the link has not been @e visited) and the mouse is not over the control.
*/ */
void SetNormalColour(const wxColour& colour); virtual void SetNormalColour(const wxColour& colour);
/** /**
Sets the URL associated with the hyperlink. Sets the URL associated with the hyperlink.
*/ */
void SetURL(const wxString& url); virtual void SetURL(const wxString& url);
/** /**
Marks the hyperlink as visited (see wxHyperlinkCtrl::SetVisitedColour). Marks the hyperlink as visited (see wxHyperlinkCtrl::SetVisitedColour).
@@ -179,6 +179,6 @@ public:
and the link has already been clicked before (i.e. the link has been @e and the link has already been clicked before (i.e. the link has been @e
visited). visited).
*/ */
void SetVisitedColour(const wxColour& colour); virtual void SetVisitedColour(const wxColour& colour);
}; };

2
interface/wx/icon.h
View File

@@ -180,7 +180,7 @@ public:
@warning @warning
Do not delete an icon that is selected into a memory device context. Do not delete an icon that is selected into a memory device context.
*/ */
~wxIcon(); virtual ~wxIcon();
/** /**
Copies @a bmp bitmap to this icon. Copies @a bmp bitmap to this icon.

2
interface/wx/iconbndl.h
View File

@@ -35,7 +35,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxIconBundle(); virtual ~wxIconBundle();
//@{ //@{
/** /**

21
interface/wx/image.h
View File

@@ -39,7 +39,7 @@ public:
/** /**
Destroys the wxImageHandler object. Destroys the wxImageHandler object.
*/ */
~wxImageHandler(); virtual ~wxImageHandler();
/** /**
Gets the file extension associated with this handler. Gets the file extension associated with this handler.
@@ -58,7 +58,7 @@ public:
@return Number of available images. For most image handlers, this is 1 @return Number of available images. For most image handlers, this is 1
(exceptions are TIFF and ICO formats). (exceptions are TIFF and ICO formats).
*/ */
int GetImageCount(wxInputStream& stream); virtual int GetImageCount(wxInputStream& stream);
/** /**
Gets the MIME type associated with this handler. Gets the MIME type associated with this handler.
@@ -312,7 +312,7 @@ public:
See @ref overview_refcountdestruct "reference-counted object destruction" for See @ref overview_refcountdestruct "reference-counted object destruction" for
more info. more info.
*/ */
~wxImage(); virtual ~wxImage();
/** /**
Register an image handler. Register an image handler.
@@ -326,7 +326,7 @@ public:
@see BlurHorizontal(), BlurVertical() @see BlurHorizontal(), BlurVertical()
*/ */
wxImage Blur(int blurRadius); wxImage Blur(int blurRadius) const;
/** /**
Blurs the image in the horizontal direction only. This should not be used Blurs the image in the horizontal direction only. This should not be used
@@ -334,7 +334,7 @@ public:
@see Blur(), BlurVertical() @see Blur(), BlurVertical()
*/ */
wxImage BlurHorizontal(int blurRadius); wxImage BlurHorizontal(int blurRadius) const;
/** /**
Blurs the image in the vertical direction only. This should not be used Blurs the image in the vertical direction only. This should not be used
@@ -342,12 +342,12 @@ public:
@see Blur(), BlurHorizontal() @see Blur(), BlurHorizontal()
*/ */
wxImage BlurVertical(int blurRadius); wxImage BlurVertical(int blurRadius) const;
/** /**
Returns @true if the current image handlers can read this file Returns @true if the current image handlers can read this file
*/ */
bool CanRead(const wxString& filename); static bool CanRead(const wxString& filename);
/** /**
Deletes all image handlers. Deletes all image handlers.
@@ -436,10 +436,9 @@ public:
@return Returns @false if there is no unused colour left, @true on success. @return Returns @false if there is no unused colour left, @true on success.
*/ */
bool FindFirstUnusedColour(unsigned char* r, unsigned char* g, bool FindFirstUnusedColour(unsigned char* r, unsigned char* g,
unsigned char* b, unsigned char* b, unsigned char startR = 1,
unsigned char startR = 1,
unsigned char startG = 0, unsigned char startG = 0,
unsigned char startB = 0); unsigned char startB = 0) const;
//@{ //@{
/** /**
@@ -853,7 +852,7 @@ public:
*/ */
wxImage Rotate(double angle, const wxPoint& rotationCentre, wxImage Rotate(double angle, const wxPoint& rotationCentre,
bool interpolating = true, bool interpolating = true,
wxPoint* offsetAfterRotation = NULL); wxPoint* offsetAfterRotation = NULL) const;
/** /**
Returns a copy of the image rotated 90 degrees in the direction Returns a copy of the image rotated 90 degrees in the direction

10
interface/wx/imaglist.h
View File

@@ -138,9 +138,9 @@ public:
For optimisation - drawing can be faster if the function is told For optimisation - drawing can be faster if the function is told
that the background is solid. that the background is solid.
*/ */
bool Draw(int index, wxDC& dc, int x, int y, virtual bool Draw(int index, wxDC& dc, int x, int y,
int flags = wxIMAGELIST_DRAW_NORMAL, int flags = wxIMAGELIST_DRAW_NORMAL,
bool solidBackground = false); bool solidBackground = false);
/** /**
Returns the bitmap corresponding to the given index. Returns the bitmap corresponding to the given index.
@@ -155,7 +155,7 @@ public:
/** /**
Returns the number of images in the list. Returns the number of images in the list.
*/ */
int GetImageCount() const; virtual int GetImageCount() const;
/** /**
Retrieves the size of the images in the list. Currently, the @a index Retrieves the size of the images in the list. Currently, the @a index
@@ -171,7 +171,7 @@ public:
@return @true if the function succeeded, @false if it failed (for example, @return @true if the function succeeded, @false if it failed (for example,
if the image list was not yet initialized). if the image list was not yet initialized).
*/ */
bool GetSize(int index, int& width, int& height) const; virtual bool GetSize(int index, int& width, int& height) const;
/** /**
Removes the image at the given position. Removes the image at the given position.

4
interface/wx/intl.h
View File

@@ -86,7 +86,7 @@ public:
set locale is restored and so the changes described in set locale is restored and so the changes described in
Init() documentation are rolled back. Init() documentation are rolled back.
*/ */
~wxLocale(); virtual ~wxLocale();
//@{ //@{
/** /**
@@ -129,7 +129,7 @@ public:
(in this order). (in this order).
This only applies to subsequent invocations of AddCatalog(). This only applies to subsequent invocations of AddCatalog().
*/ */
void AddCatalogLookupPathPrefix(const wxString& prefix); static void AddCatalogLookupPathPrefix(const wxString& prefix);
/** /**
Adds custom, user-defined language to the database of known languages. This Adds custom, user-defined language to the database of known languages. This

2
interface/wx/joystick.h
View File

@@ -29,7 +29,7 @@ public:
/** /**
Destroys the wxJoystick object. Destroys the wxJoystick object.
*/ */
~wxJoystick(); virtual ~wxJoystick();
//@{ //@{
/** /**

8
interface/wx/laywin.h
View File

@@ -102,14 +102,14 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxLayoutAlgorithm(); virtual ~wxLayoutAlgorithm();
/** /**
Lays out the children of a normal frame. @a mainWindow is set to occupy the Lays out the children of a normal frame. @a mainWindow is set to occupy the
remaining space. remaining space.
This function simply calls LayoutWindow(). This function simply calls LayoutWindow().
*/ */
bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = NULL) const; bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = NULL);
/** /**
Lays out the children of an MDI parent frame. If @a rect is non-@NULL, the Lays out the children of an MDI parent frame. If @a rect is non-@NULL, the
@@ -117,7 +117,7 @@ public:
area. area.
The MDI client window is set to occupy the remaining space. The MDI client window is set to occupy the remaining space.
*/ */
bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = NULL) const; bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = NULL);
/** /**
Lays out the children of a normal frame or other window. Lays out the children of a normal frame or other window.
@@ -129,7 +129,7 @@ public:
and the window will be set and the window will be set
to the remaining size). to the remaining size).
*/ */
bool LayoutWindow(wxWindow* parent, wxWindow* mainWindow = NULL) const; bool LayoutWindow(wxWindow* parent, wxWindow* mainWindow = NULL);
}; };

6
interface/wx/listbox.h
View File

@@ -103,7 +103,7 @@ public:
/** /**
Destructor, destroying the list box. Destructor, destroying the list box.
*/ */
~wxListBox(); virtual ~wxListBox();
//@{ //@{
/** /**
@@ -151,7 +151,7 @@ public:
@see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection, @see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection,
wxControlWithItems::SetSelection wxControlWithItems::SetSelection
*/ */
int GetSelections(wxArrayInt& selections) const; virtual int GetSelections(wxArrayInt& selections) const;
/** /**
Returns the item located at @e point, or @c wxNOT_FOUND if there Returns the item located at @e point, or @c wxNOT_FOUND if there
@@ -203,7 +203,7 @@ public:
@return @true if the given item is selected, @false otherwise. @return @true if the given item is selected, @false otherwise.
*/ */
bool IsSelected(int n) const; virtual bool IsSelected(int n) const;
/** /**
Clears the list box and adds the given strings to it. Clears the list box and adds the given strings to it.

2
interface/wx/listctrl.h
View File

@@ -182,7 +182,7 @@ public:
/** /**
Destructor, destroying the list control. Destructor, destroying the list control.
*/ */
~wxListCtrl(); virtual ~wxListCtrl();
/** /**
Arranges the items in icon or small icon view. This only has effect on Win32. Arranges the items in icon or small icon view. This only has effect on Win32.

4
interface/wx/log.h
View File

@@ -144,7 +144,7 @@ public:
/** /**
Destroys the previous log target. Destroys the previous log target.
*/ */
~wxLogChain(); virtual ~wxLogChain();
/** /**
Detaches the old log target so it won't be destroyed when the wxLogChain object Detaches the old log target so it won't be destroyed when the wxLogChain object
@@ -669,7 +669,7 @@ public:
Disables time stamping of the log messages. Disables time stamping of the log messages.
This function is new since wxWidgets version 2.9 This function is new since wxWidgets version 2.9
*/ */
void SetTimestamp(const wxString& format); static void SetTimestamp(const wxString& format);
/** /**
Called to process the message of the specified severity. @a msg is the text Called to process the message of the specified severity. @a msg is the text

22
interface/wx/mdi.h
View File

@@ -60,13 +60,13 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxMDIClientWindow(); virtual ~wxMDIClientWindow();
/** /**
Used in two-step frame construction. See wxMDIClientWindow() Used in two-step frame construction. See wxMDIClientWindow()
for further details. for further details.
*/ */
bool CreateClient(wxMDIParentFrame* parent, long style = 0); virtual bool CreateClient(wxMDIParentFrame* parent, long style = 0);
}; };
@@ -189,35 +189,35 @@ public:
/** /**
Destructor. Destroys all child windows and menu bar if present. Destructor. Destroys all child windows and menu bar if present.
*/ */
~wxMDIParentFrame(); virtual ~wxMDIParentFrame();
/** /**
Activates the MDI child following the currently active one. Activates the MDI child following the currently active one.
@see ActivatePrevious() @see ActivatePrevious()
*/ */
void ActivateNext(); virtual void ActivateNext();
/** /**
Activates the MDI child preceding the currently active one. Activates the MDI child preceding the currently active one.
@see ActivateNext() @see ActivateNext()
*/ */
void ActivatePrevious(); virtual void ActivatePrevious();
/** /**
Arranges any iconized (minimized) MDI child windows. Arranges any iconized (minimized) MDI child windows.
@see Cascade(), Tile() @see Cascade(), Tile()
*/ */
void ArrangeIcons(); virtual void ArrangeIcons();
/** /**
Arranges the MDI child windows in a cascade. Arranges the MDI child windows in a cascade.
@see Tile(), ArrangeIcons() @see Tile(), ArrangeIcons()
*/ */
void Cascade(); virtual void Cascade();
/** /**
Used in two-step frame construction. See wxMDIParentFrame() Used in two-step frame construction. See wxMDIParentFrame()
@@ -368,7 +368,7 @@ public:
Currently only implemented for MSW, does nothing under the other platforms. Currently only implemented for MSW, does nothing under the other platforms.
*/ */
void Tile(wxOrientation orient = wxHORIZONTAL); virtual void Tile(wxOrientation orient = wxHORIZONTAL);
}; };
@@ -456,14 +456,14 @@ public:
/** /**
Destructor. Destroys all child windows and menu bar if present. Destructor. Destroys all child windows and menu bar if present.
*/ */
~wxMDIChildFrame(); virtual ~wxMDIChildFrame();
/** /**
Activates this MDI child frame. Activates this MDI child frame.
@see Maximize(), Restore() @see Maximize(), Restore()
*/ */
void Activate(); virtual void Activate();
/** /**
Used in two-step frame construction. See wxMDIChildFrame() Used in two-step frame construction. See wxMDIChildFrame()
@@ -486,6 +486,6 @@ public:
/** /**
Restores this MDI child frame (unmaximizes). Restores this MDI child frame (unmaximizes).
*/ */
void Restore(); virtual void Restore();
}; };

14
interface/wx/mediactrl.h
View File

@@ -220,10 +220,11 @@ public:
@param name @param name
Window name. Window name.
*/ */
wxMediaCtrl( wxWindow* parent, wxWindowID id, const wxString& fileName = wxT(""), wxMediaCtrl(wxWindow* parent, wxWindowID id, const wxString& fileName = wxT(""),
const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
long style = 0, const wxString& szBackend = wxT(""), const wxValidatorvalidator = wxDefaultValidator, long style = 0, const wxString& szBackend = wxT(""),
const wxString& name = wxPanelNameStr ); const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPanelNameStr);
/** /**
@@ -254,10 +255,11 @@ public:
@param name @param name
Window name. Window name.
*/ */
bool Create( wxWindow* parent, wxWindowID id, const wxString& fileName = wxT(""), bool Create(wxWindow* parent, wxWindowID id, const wxString& fileName = wxT(""),
const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
long style = 0, const wxString& szBackend = wxT(""), const wxValidatorvalidator = wxDefaultValidator, long style = 0, const wxString& szBackend = wxT(""),
const wxString& name = wxPanelNameStr ); const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPanelNameStr);
/** /**
Obtains the best size relative to the original/natural size of the Obtains the best size relative to the original/natural size of the

27
interface/wx/menu.h
View File

@@ -48,7 +48,7 @@ public:
Destructor, destroying the menu bar and removing it from the parent frame (if Destructor, destroying the menu bar and removing it from the parent frame (if
any). any).
*/ */
~wxMenuBar(); virtual ~wxMenuBar();
/** /**
Adds the item to the end of the menu bar. Adds the item to the end of the menu bar.
@@ -62,7 +62,7 @@ public:
@see Insert() @see Insert()
*/ */
bool Append(wxMenu* menu, const wxString& title); virtual bool Append(wxMenu* menu, const wxString& title);
/** /**
Checks or unchecks a menu item. Checks or unchecks a menu item.
@@ -239,7 +239,7 @@ public:
@see Append() @see Append()
*/ */
bool Insert(size_t pos, wxMenu* menu, const wxString& title); virtual bool Insert(size_t pos, wxMenu* menu, const wxString& title);
/** /**
Determines whether an item is checked. Determines whether an item is checked.
@@ -274,7 +274,7 @@ public:
@see Replace() @see Replace()
*/ */
wxMenu* Remove(size_t pos); virtual wxMenu* Remove(size_t pos);
/** /**
Replaces the menu at the given position with another one. Replaces the menu at the given position with another one.
@@ -291,7 +291,7 @@ public:
@see Insert(), Remove() @see Insert(), Remove()
*/ */
wxMenu* Replace(size_t pos, wxMenu* menu, const wxString& title); virtual wxMenu* Replace(size_t pos, wxMenu* menu, const wxString& title);
/** /**
Sets the help string associated with a menu item. Sets the help string associated with a menu item.
@@ -422,7 +422,7 @@ public:
a different window from last time, which causes an implicit destruction a different window from last time, which causes an implicit destruction
and recreation of internal data structures. and recreation of internal data structures.
*/ */
~wxMenu(); virtual ~wxMenu();
/** /**
Adds a menu item. Adds a menu item.
@@ -467,8 +467,7 @@ public:
AppendSubMenu(), Insert(), SetLabel(), AppendSubMenu(), Insert(), SetLabel(),
GetHelpString(), SetHelpString(), wxMenuItem GetHelpString(), SetHelpString(), wxMenuItem
*/ */
wxMenuItem* Append(int id, const wxString& item, wxMenuItem* Append(int id, const wxString& item, wxMenu* subMenu,
wxMenu* subMenu,
const wxString& helpString = wxEmptyString); const wxString& helpString = wxEmptyString);
/** /**
@@ -524,7 +523,7 @@ public:
Inserts a break in a menu, causing the next appended item to appear in a new Inserts a break in a menu, causing the next appended item to appear in a new
column. column.
*/ */
void Break(); virtual void Break();
/** /**
Checks or unchecks the menu item. Checks or unchecks the menu item.
@@ -607,7 +606,7 @@ public:
@remarks Any special menu codes are stripped out of source and target @remarks Any special menu codes are stripped out of source and target
strings before matching. strings before matching.
*/ */
int FindItem(const wxString& itemString) const; virtual int FindItem(const wxString& itemString) const;
/** /**
Finds the menu item object associated with the given menu item identifier and, Finds the menu item object associated with the given menu item identifier and,
@@ -639,7 +638,7 @@ public:
@see SetHelpString(), Append() @see SetHelpString(), Append()
*/ */
wxString GetHelpString(int id) const; virtual wxString GetHelpString(int id) const;
/** /**
Returns a menu item label. Returns a menu item label.
@@ -832,7 +831,7 @@ public:
@see GetHelpString() @see GetHelpString()
*/ */
void SetHelpString(int id, const wxString& helpString); virtual void SetHelpString(int id, const wxString& helpString);
/** /**
Sets the label of a menu item. Sets the label of a menu item.
@@ -857,7 +856,7 @@ public:
@see GetTitle() @see GetTitle()
*/ */
void SetTitle(const wxString& title); virtual void SetTitle(const wxString& title);
/** /**
Sends events to @a source (or owning window if @NULL) to update the Sends events to @a source (or owning window if @NULL) to update the
@@ -865,6 +864,6 @@ public:
wxWindow::PopupMenu, but wxWindow::PopupMenu, but
the application may call it at other times if required. the application may call it at other times if required.
*/ */
void UpdateUI(wxEvtHandler* source = NULL) const; void UpdateUI(wxEvtHandler* source = NULL);
}; };

20
interface/wx/menuitem.h
View File

@@ -68,18 +68,18 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxMenuItem(); virtual ~wxMenuItem();
/** /**
Checks or unchecks the menu item. Checks or unchecks the menu item.
Note that this only works when the item is already appended to a menu. Note that this only works when the item is already appended to a menu.
*/ */
void Check(bool check = true); virtual void Check(bool check = true);
/** /**
Enables or disables the menu item. Enables or disables the menu item.
*/ */
void Enable(bool enable = true); virtual void Enable(bool enable = true);
/** /**
Returns the background colour associated with the menu item (Windows only). Returns the background colour associated with the menu item (Windows only).
@@ -112,7 +112,7 @@ public:
@see GetItemLabelText(), GetLabelText() @see GetItemLabelText(), GetLabelText()
*/ */
wxString GetItemLabel() const; virtual wxString GetItemLabel() const;
/** /**
Returns the text associated with the menu item, without any accelerator Returns the text associated with the menu item, without any accelerator
@@ -120,7 +120,7 @@ public:
@see GetItemLabel(), GetLabelText() @see GetItemLabel(), GetLabelText()
*/ */
wxString GetItemLabelText() const; virtual wxString GetItemLabelText() const;
/** /**
Returns the item kind, one of @c wxITEM_SEPARATOR, @c wxITEM_NORMAL, Returns the item kind, one of @c wxITEM_SEPARATOR, @c wxITEM_NORMAL,
@@ -200,12 +200,12 @@ public:
/** /**
Returns @true if the item is checked. Returns @true if the item is checked.
*/ */
bool IsChecked() const; virtual bool IsChecked() const;
/** /**
Returns @true if the item is enabled. Returns @true if the item is enabled.
*/ */
bool IsEnabled() const; virtual bool IsEnabled() const;
/** /**
Returns @true if the item is a separator. Returns @true if the item is a separator.
@@ -226,7 +226,7 @@ public:
Sets the bitmap for the menu item (Windows and GTK+ only). It is Sets the bitmap for the menu item (Windows and GTK+ only). It is
equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap). equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap).
*/ */
void SetBitmap(const wxBitmap& bmp); virtual void SetBitmap(const wxBitmap& bmp);
/** /**
Sets the checked/unchecked bitmaps for the menu item (Windows only). The first Sets the checked/unchecked bitmaps for the menu item (Windows only). The first
@@ -249,7 +249,7 @@ public:
/** /**
Sets the label associated with the menu item. Sets the label associated with the menu item.
*/ */
void SetItemLabel(const wxString& label); virtual void SetItemLabel(const wxString& label);
/** /**
Sets the width of the menu item checkmark bitmap (Windows only). Sets the width of the menu item checkmark bitmap (Windows only).
@@ -270,7 +270,7 @@ public:
Sets the text associated with the menu item. Sets the text associated with the menu item.
@deprecated This function is deprecated in favour of SetItemLabel(). @deprecated This function is deprecated in favour of SetItemLabel().
*/ */
void SetText(const wxString& text); virtual void SetText(const wxString& text);
/** /**
Sets the text colour associated with the menu item (Windows only). Sets the text colour associated with the menu item (Windows only).

6
interface/wx/mimetype.h
View File

@@ -172,7 +172,7 @@ public:
with a brief description for this file type: for example, "text document" for with a brief description for this file type: for example, "text document" for
the "text/plain" MIME type. the "text/plain" MIME type.
*/ */
bool GetDescription(wxString* desc); bool GetDescription(wxString* desc) const;
/** /**
If the function returns @true, the array @a extensions is filled If the function returns @true, the array @a extensions is filled
@@ -199,13 +199,13 @@ public:
and KDE settings and thus GetIcon's success depends on availability and KDE settings and thus GetIcon's success depends on availability
of these desktop environments. of these desktop environments.
*/ */
bool GetIcon(wxIconLocation* iconLoc); bool GetIcon(wxIconLocation* iconLoc) const;
/** /**
If the function returns @true, the string pointed to by @a mimeType is filled If the function returns @true, the string pointed to by @a mimeType is filled
with full MIME type specification for this file type: for example, "text/plain". with full MIME type specification for this file type: for example, "text/plain".
*/ */
bool GetMimeType(wxString* mimeType); bool GetMimeType(wxString* mimeType) const;
/** /**
Same as GetMimeType() but returns array of MIME Same as GetMimeType() but returns array of MIME

2
interface/wx/minifram.h
View File

@@ -95,7 +95,7 @@ public:
/** /**
Destructor. Destroys all child windows and menu bar if present. Destructor. Destroys all child windows and menu bar if present.
*/ */
~wxMiniFrame(); virtual ~wxMiniFrame();
/** /**
Used in two-step frame construction. See wxMiniFrame() Used in two-step frame construction. See wxMiniFrame()

2
interface/wx/module.h
View File

@@ -86,7 +86,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxModule(); virtual ~wxModule();
//@{ //@{
/** /**

9
interface/wx/msgdlg.h
View File

@@ -110,14 +110,15 @@ public:
Please see the remarks in SetYesNoLabels() documentation. Please see the remarks in SetYesNoLabels() documentation.
*/ */
bool SetOKCancelLabels(const ButtonLabel& ok, const ButtonLabel& cancel); virtual bool SetOKCancelLabels(const ButtonLabel& ok,
const ButtonLabel& cancel);
/** /**
Overrides the default label of the OK button. Overrides the default label of the OK button.
Please see the remarks in SetYesNoLabels() documentation. Please see the remarks in SetYesNoLabels() documentation.
*/ */
bool SetOKLabel(const ButtonLabel& ok); virtual bool SetOKLabel(const ButtonLabel& ok);
/** /**
Overrides the default labels of the Yes, No and Cancel buttons. Overrides the default labels of the Yes, No and Cancel buttons.
@@ -157,7 +158,7 @@ public:
dlg.SetMessage(_("Do you really want to quit?")); dlg.SetMessage(_("Do you really want to quit?"));
@endcode @endcode
*/ */
bool SetYesNoLabels(const ButtonLabel& yes, const ButtonLabel& no); virtual bool SetYesNoLabels(const ButtonLabel& yes, const ButtonLabel& no);
/** /**
Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES, Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES,
@@ -166,7 +167,7 @@ public:
Notice that this method returns the identifier of the button which was Notice that this method returns the identifier of the button which was
clicked unlike wxMessageBox() function. clicked unlike wxMessageBox() function.
*/ */
int ShowModal(); virtual int ShowModal();
}; };

4
interface/wx/mstream.h
View File

@@ -27,7 +27,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxMemoryOutputStream(); virtual ~wxMemoryOutputStream();
/** /**
CopyTo allowed you to transfer data from the internal buffer of CopyTo allowed you to transfer data from the internal buffer of
@@ -74,7 +74,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxMemoryInputStream(); virtual ~wxMemoryInputStream();
/** /**
Returns the pointer to the stream object used as an internal buffer Returns the pointer to the stream object used as an internal buffer

9
interface/wx/notebook.h
View File

@@ -251,10 +251,9 @@ public:
@see AddPage() @see AddPage()
*/ */
bool InsertPage(size_t index, wxNotebookPage* page, virtual bool InsertPage(size_t index, wxNotebookPage* page,
const wxString& text, const wxString& text, bool select = false,
bool select = false, int imageId = -1);
int imageId = -1);
/** /**
An event handler function, called when the page selection is changed. An event handler function, called when the page selection is changed.
@@ -280,7 +279,7 @@ public:
Sets the amount of space around each page's icon and label, in pixels. Sets the amount of space around each page's icon and label, in pixels.
@note The vertical padding cannot be changed in wxGTK. @note The vertical padding cannot be changed in wxGTK.
*/ */
void SetPadding(const wxSize& padding); virtual void SetPadding(const wxSize& padding);
/** /**
Sets the image index for the given page. @a image is an index into Sets the image index for the given page. @a image is an index into

4
interface/wx/notifmsg.h
View File

@@ -43,7 +43,7 @@ public:
some some
systems automatically hidden notifications can't be hidden manually) systems automatically hidden notifications can't be hidden manually)
*/ */
bool Close(); virtual bool Close();
/** /**
This parameter can be currently used to specify the icon to show in the This parameter can be currently used to specify the icon to show in the
@@ -83,6 +83,6 @@ public:
and also because the user may be able to close the notification. and also because the user may be able to close the notification.
Returns @false if an error occurred. Returns @false if an error occurred.
*/ */
bool Show(int timeout = Timeout_Auto); virtual bool Show(int timeout = Timeout_Auto);
}; };

4
interface/wx/object.h
View File

@@ -200,7 +200,7 @@ public:
Performs dereferencing, for those objects that use reference counting. Performs dereferencing, for those objects that use reference counting.
*/ */
~wxObject(); virtual ~wxObject();
/** /**
A virtual function that may be redefined by derived classes to allow dumping of A virtual function that may be redefined by derived classes to allow dumping of
@@ -225,7 +225,7 @@ public:
This virtual function is redefined for every class that requires run-time This virtual function is redefined for every class that requires run-time
type information, when using the ::DECLARE_CLASS macro (or similar). type information, when using the ::DECLARE_CLASS macro (or similar).
*/ */
wxClassInfo* GetClassInfo(); virtual wxClassInfo* GetClassInfo() const;
/** /**
Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

6
interface/wx/odcombo.h
View File

@@ -143,7 +143,7 @@ public:
/** /**
Destructor, destroying the owner-drawn combobox. Destructor, destroying the owner-drawn combobox.
*/ */
~wxOwnerDrawnComboBox(); virtual ~wxOwnerDrawnComboBox();
//@{ //@{
/** /**
@@ -173,12 +173,12 @@ public:
/** /**
Returns index to the widest item in the list. Returns index to the widest item in the list.
*/ */
int GetWidestItem() const; virtual int GetWidestItem();
/** /**
Returns width of the widest item in the list. Returns width of the widest item in the list.
*/ */
int GetWidestItemWidth() const; virtual int GetWidestItemWidth();
/** /**
This method is used to draw the items background and, maybe, a border around it. This method is used to draw the items background and, maybe, a border around it.

4
interface/wx/palette.h
View File

@@ -70,7 +70,7 @@ public:
@see @ref overview_refcount_destruct "reference-counted object destruction" @see @ref overview_refcount_destruct "reference-counted object destruction"
*/ */
~wxPalette(); virtual ~wxPalette();
/** /**
Creates a palette from arrays of size @a n, one for each red, blue or Creates a palette from arrays of size @a n, one for each red, blue or
@@ -96,7 +96,7 @@ public:
/** /**
Returns number of entries in palette. Returns number of entries in palette.
*/ */
int GetColoursCount() const; virtual int GetColoursCount() const;
/** /**
Returns a pixel value (index into the palette) for the given RGB values. Returns a pixel value (index into the palette) for the given RGB values.

6
interface/wx/panel.h
View File

@@ -69,7 +69,7 @@ public:
/** /**
Destructor. Deletes any child windows before deleting the physical window. Destructor. Deletes any child windows before deleting the physical window.
*/ */
~wxPanel(); virtual ~wxPanel();
/** /**
This method is overridden from wxWindow::AcceptsFocus() This method is overridden from wxWindow::AcceptsFocus()
@@ -94,7 +94,7 @@ public:
@see wxInitDialogEvent @see wxInitDialogEvent
*/ */
void InitDialog(); virtual void InitDialog();
/** /**
The default handler for wxEVT_SYS_COLOUR_CHANGED. The default handler for wxEVT_SYS_COLOUR_CHANGED.
@@ -130,6 +130,6 @@ public:
In contrast to SetFocus() (see above) this will set the focus to the panel In contrast to SetFocus() (see above) this will set the focus to the panel
even if there are child windows in the panel. This is only rarely needed. even if there are child windows in the panel. This is only rarely needed.
*/ */
virtual void SetFocusIgnoringChildren(); void SetFocusIgnoringChildren();
}; };

2
interface/wx/pen.h
View File

@@ -201,7 +201,7 @@ public:
pointer to the pen object is stored in an application pointer to the pen object is stored in an application
data structure, and there is a risk of double deletion. data structure, and there is a risk of double deletion.
*/ */
~wxPen(); virtual ~wxPen();
/** /**
Returns the pen cap style, which may be one of @c wxCAP_ROUND, @c Returns the pen cap style, which may be one of @c wxCAP_ROUND, @c

92
interface/wx/print.h
View File

@@ -55,29 +55,29 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxPreviewControlBar(); virtual ~wxPreviewControlBar();
/** /**
Creates buttons, according to value of the button style flags. Creates buttons, according to value of the button style flags.
@todo which flags?? @todo which flags??
*/ */
void CreateButtons(); virtual void CreateButtons();
/** /**
Gets the print preview object associated with the control bar. Gets the print preview object associated with the control bar.
*/ */
wxPrintPreview* GetPrintPreview(); virtual wxPrintPreviewBase* GetPrintPreview() const;
/** /**
Gets the current zoom setting in percent. Gets the current zoom setting in percent.
*/ */
int GetZoomControl(); virtual int GetZoomControl();
/** /**
Sets the zoom control. Sets the zoom control.
*/ */
void SetZoomControl(int percent); virtual void SetZoomControl(int percent);
}; };
@@ -109,7 +109,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxPreviewCanvas(); virtual ~wxPreviewCanvas();
/** /**
Calls wxPrintPreview::PaintPage() to refresh the canvas. Calls wxPrintPreview::PaintPage() to refresh the canvas.
@@ -150,7 +150,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxPreviewFrame(); virtual ~wxPreviewFrame();
/** /**
Creates a wxPreviewCanvas. Creates a wxPreviewCanvas.
@@ -158,7 +158,7 @@ public:
Override this function to allow a user-defined preview canvas object Override this function to allow a user-defined preview canvas object
to be created. to be created.
*/ */
void CreateCanvas(); virtual void CreateCanvas();
/** /**
Creates a wxPreviewControlBar. Creates a wxPreviewControlBar.
@@ -166,7 +166,7 @@ public:
Override this function to allow a user-defined preview control bar object Override this function to allow a user-defined preview control bar object
to be created. to be created.
*/ */
void CreateControlBar(); virtual void CreateControlBar();
/** /**
Creates the preview canvas and control bar, and calls wxWindow::MakeModal(@true) Creates the preview canvas and control bar, and calls wxWindow::MakeModal(@true)
@@ -174,7 +174,7 @@ public:
This function should be called by the application prior to showing the frame. This function should be called by the application prior to showing the frame.
*/ */
void Initialize(); virtual void Initialize();
/** /**
Enables the other frames in the application, and deletes the print preview Enables the other frames in the application, and deletes the print preview
@@ -245,40 +245,40 @@ public:
/** /**
Gets the preview window used for displaying the print preview image. Gets the preview window used for displaying the print preview image.
*/ */
wxPreviewCanvas* GetCanvas(); virtual wxPreviewCanvas* GetCanvas() const;
/** /**
Gets the page currently being previewed. Gets the page currently being previewed.
*/ */
int GetCurrentPage(); virtual int GetCurrentPage() const;
/** /**
Gets the frame used for displaying the print preview canvas Gets the frame used for displaying the print preview canvas
and control bar. and control bar.
*/ */
wxFrame* GetFrame(); virtual wxFrame* GetFrame() const;
/** /**
Returns the maximum page number. Returns the maximum page number.
*/ */
int GetMaxPage(); virtual int GetMaxPage() const;
/** /**
Returns the minimum page number. Returns the minimum page number.
*/ */
int GetMinPage(); virtual int GetMinPage() const;
/** /**
Gets the preview printout object associated with the wxPrintPreview object. Gets the preview printout object associated with the wxPrintPreview object.
*/ */
wxPrintout* GetPrintout(); virtual wxPrintout* GetPrintout() const;
/** /**
Gets the printout object to be used for printing from within the preview Gets the printout object to be used for printing from within the preview
interface, interface,
or @NULL if none exists. or @NULL if none exists.
*/ */
wxPrintout* GetPrintoutForPrinting(); virtual wxPrintout* GetPrintoutForPrinting() const;
/** /**
Returns @true if the wxPrintPreview is valid, @false otherwise. Returns @true if the wxPrintPreview is valid, @false otherwise.
@@ -286,7 +286,7 @@ public:
It could return @false if there was a problem initializing the printer It could return @false if there was a problem initializing the printer
device context (current printer not set, for example). device context (current printer not set, for example).
*/ */
bool IsOk(); virtual bool IsOk() const;
/** /**
This refreshes the preview window with the preview image. This refreshes the preview window with the preview image.
@@ -306,17 +306,17 @@ public:
Returns @false in case of error -- call wxPrinter::GetLastError() Returns @false in case of error -- call wxPrinter::GetLastError()
to get detailed information about the kind of the error. to get detailed information about the kind of the error.
*/ */
bool Print(bool prompt); virtual bool Print(bool prompt);
/** /**
Renders a page into a wxMemoryDC. Used internally by wxPrintPreview. Renders a page into a wxMemoryDC. Used internally by wxPrintPreview.
*/ */
bool RenderPage(int pageNum); virtual bool RenderPage(int pageNum);
/** /**
Sets the window to be used for displaying the print preview image. Sets the window to be used for displaying the print preview image.
*/ */
void SetCanvas(wxPreviewCanvas* window); virtual void SetCanvas(wxPreviewCanvas* window);
/** /**
Sets the current page to be previewed. Sets the current page to be previewed.
@@ -327,17 +327,17 @@ public:
Sets the frame to be used for displaying the print preview canvas Sets the frame to be used for displaying the print preview canvas
and control bar. and control bar.
*/ */
void SetFrame(wxFrame* frame); virtual void SetFrame(wxFrame* frame);
/** /**
Associates a printout object with the wxPrintPreview object. Associates a printout object with the wxPrintPreview object.
*/ */
void SetPrintout(wxPrintout* printout); virtual void SetPrintout(wxPrintout* printout);
/** /**
Sets the percentage preview zoom, and refreshes the preview canvas accordingly. Sets the percentage preview zoom, and refreshes the preview canvas accordingly.
*/ */
void SetZoom(int percent); virtual void SetZoom(int percent);
}; };
@@ -378,7 +378,7 @@ public:
/** /**
Returns @true if the user has aborted the print job. Returns @true if the user has aborted the print job.
*/ */
bool GetAbort(); bool GetAbort() const;
/** /**
Return last error. Valid after calling Print(), PrintDialog() or Return last error. Valid after calling Print(), PrintDialog() or
@@ -400,7 +400,7 @@ public:
Returns the @ref overview_printing_printdata "print data" associated with Returns the @ref overview_printing_printdata "print data" associated with
the printer object. the printer object.
*/ */
wxPrintDialogData& GetPrintDialogData(); virtual wxPrintDialogData& GetPrintDialogData() const;
/** /**
Starts the printing process. Provide a parent window, a user-defined wxPrintout Starts the printing process. Provide a parent window, a user-defined wxPrintout
@@ -424,7 +424,7 @@ public:
@remarks @remarks
The application must delete this device context to avoid a memory leak. The application must delete this device context to avoid a memory leak.
*/ */
wxDC* PrintDialog(wxWindow* parent); virtual wxDC* PrintDialog(wxWindow* parent);
/** /**
Default error-reporting function. Default error-reporting function.
@@ -439,7 +439,7 @@ public:
The setup dialog is obsolete from Windows 95, though retained The setup dialog is obsolete from Windows 95, though retained
for backward compatibility. for backward compatibility.
*/ */
bool Setup(wxWindow* parent); virtual bool Setup(wxWindow* parent);
}; };
@@ -490,7 +490,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxPrintout(); virtual ~wxPrintout();
/** /**
Set the user scale and device origin of the wxDC associated with this wxPrintout Set the user scale and device origin of the wxDC associated with this wxPrintout
@@ -544,7 +544,7 @@ public:
This will be a wxPrinterDC if printing under Windows or Mac, a wxPostScriptDC This will be a wxPrinterDC if printing under Windows or Mac, a wxPostScriptDC
if printing on other platforms, and a wxMemoryDC if previewing. if printing on other platforms, and a wxMemoryDC if previewing.
*/ */
wxDC* GetDC(); wxDC* GetDC() const;
/** /**
Return the rectangle corresponding to the page margins specified by the given Return the rectangle corresponding to the page margins specified by the given
@@ -554,7 +554,7 @@ public:
The page margins are specified with respect to the edges of the paper on all The page margins are specified with respect to the edges of the paper on all
platforms. platforms.
*/ */
wxRect GetLogicalPageMarginsRect(const wxPageSetupDialogData& pageSetupData); wxRect GetLogicalPageMarginsRect(const wxPageSetupDialogData& pageSetupData) const;
/** /**
Return the rectangle corresponding to the page in the associated wxDC 's Return the rectangle corresponding to the page in the associated wxDC 's
@@ -564,13 +564,13 @@ public:
On other platforms and PostScript printing, this will be the full paper On other platforms and PostScript printing, this will be the full paper
rectangle. rectangle.
*/ */
wxRect GetLogicalPageRect(); wxRect GetLogicalPageRect() const;
/** /**
Return the rectangle corresponding to the paper in the associated wxDC 's Return the rectangle corresponding to the paper in the associated wxDC 's
logical coordinates for the current user scale and device origin. logical coordinates for the current user scale and device origin.
*/ */
wxRect GetLogicalPaperRect(); wxRect GetLogicalPaperRect() const;
/** /**
Returns the number of pixels per logical inch of the printer device context. Returns the number of pixels per logical inch of the printer device context.
@@ -587,7 +587,7 @@ public:
This method returns the output-only parameters as a tuple. This method returns the output-only parameters as a tuple.
@endWxPythonOnly @endWxPythonOnly
*/ */
void GetPPIPrinter(int* w, int* h); void GetPPIPrinter(int* w, int* h) const;
/** /**
Returns the number of pixels per logical inch of the screen device context. Returns the number of pixels per logical inch of the screen device context.
@@ -602,7 +602,7 @@ public:
This method returns the output-only parameters as a tuple. This method returns the output-only parameters as a tuple.
@endWxPythonOnly @endWxPythonOnly
*/ */
void GetPPIScreen(int* w, int* h); void GetPPIScreen(int* w, int* h) const;
/** /**
Called by the framework to obtain information from the application about minimum Called by the framework to obtain information from the application about minimum
@@ -631,7 +631,7 @@ public:
This method returns the output-only parameters as a tuple. This method returns the output-only parameters as a tuple.
@endWxPythonOnly @endWxPythonOnly
*/ */
void GetPageSizeMM(int* w, int* h); void GetPageSizeMM(int* w, int* h) const;
/** /**
Returns the size of the printer page in pixels, called the page rectangle. Returns the size of the printer page in pixels, called the page rectangle.
@@ -647,7 +647,7 @@ public:
This method returns the output-only parameters as a tuple. This method returns the output-only parameters as a tuple.
@endWxPythonOnly @endWxPythonOnly
*/ */
void GetPageSizePixels(int* w, int* h); void GetPageSizePixels(int* w, int* h) const;
/** /**
Returns the rectangle that corresponds to the entire paper in pixels, called the Returns the rectangle that corresponds to the entire paper in pixels, called the
@@ -668,14 +668,14 @@ public:
area were printable, so this function will return the same rectangle as the page area were printable, so this function will return the same rectangle as the page
rectangle. rectangle.
*/ */
wxRect GetPaperRectPixels(); wxRect GetPaperRectPixels() const;
/** /**
Returns the title of the printout. Returns the title of the printout.
@todo the python note here was wrong @todo the python note here was wrong
*/ */
wxString GetTitle(); virtual wxString GetTitle() const;
/** /**
Should be overridden to return @true if the document has this page, or @false Should be overridden to return @true if the document has this page, or @false
@@ -684,12 +684,12 @@ public:
Returning @false signifies the end of the document. By default, Returning @false signifies the end of the document. By default,
HasPage behaves as if the document has only one page. HasPage behaves as if the document has only one page.
*/ */
bool HasPage(int pageNum); virtual bool HasPage(int pageNum);
/** /**
Returns @true if the printout is currently being used for previewing. Returns @true if the printout is currently being used for previewing.
*/ */
bool IsPreview(); virtual bool IsPreview() const;
/** /**
Set the user scale and device origin of the wxDC associated with this wxPrintout Set the user scale and device origin of the wxDC associated with this wxPrintout
@@ -757,7 +757,7 @@ public:
be called by using the method <tt>base_OnBeginDocument(startPage, endPage)</tt>. be called by using the method <tt>base_OnBeginDocument(startPage, endPage)</tt>.
@endWxPythonOnly @endWxPythonOnly
*/ */
bool OnBeginDocument(int startPage, int endPage); virtual bool OnBeginDocument(int startPage, int endPage);
/** /**
Called by the framework at the start of printing. Called by the framework at the start of printing.
@@ -765,7 +765,7 @@ public:
OnBeginPrinting() is called once for every print job OnBeginPrinting() is called once for every print job
(regardless of how many copies are being printed). (regardless of how many copies are being printed).
*/ */
void OnBeginPrinting(); virtual void OnBeginPrinting();
/** /**
Called by the framework at the end of document printing. Called by the framework at the end of document printing.
@@ -776,7 +776,7 @@ public:
The base OnEndDocument() must be called from within the overridden function, The base OnEndDocument() must be called from within the overridden function,
since it calls wxDC::EndDoc(). since it calls wxDC::EndDoc().
*/ */
void OnEndDocument(); virtual void OnEndDocument();
/** /**
Called by the framework at the end of printing. Called by the framework at the end of printing.
@@ -784,7 +784,7 @@ public:
OnEndPrinting is called once for every print job OnEndPrinting is called once for every print job
(regardless of how many copies are being printed). (regardless of how many copies are being printed).
*/ */
void OnEndPrinting(); virtual void OnEndPrinting();
/** /**
Called once by the framework before any other demands are made of the Called once by the framework before any other demands are made of the
@@ -793,7 +793,7 @@ public:
This gives the object an opportunity to calculate the number of pages This gives the object an opportunity to calculate the number of pages
in the document, for example. in the document, for example.
*/ */
void OnPreparePrinting(); virtual void OnPreparePrinting();
/** /**
Called by the framework when a page should be printed. Returning @false cancels Called by the framework when a page should be printed. Returning @false cancels

8
interface/wx/printdlg.h
View File

@@ -37,7 +37,7 @@ public:
If GetPrintDC() has not been called, the device context obtained by If GetPrintDC() has not been called, the device context obtained by
the dialog (if any) will be deleted. the dialog (if any) will be deleted.
*/ */
~wxPrintDialog(); virtual ~wxPrintDialog();
/** /**
Returns the device context created by the print dialog, if any. Returns the device context created by the print dialog, if any.
@@ -46,7 +46,7 @@ public:
is transferred to the application, so it must then be deleted is transferred to the application, so it must then be deleted
explicitly. explicitly.
*/ */
wxDC* GetPrintDC(); virtual wxDC* GetPrintDC();
/** /**
Returns the @ref overview_printing_printdata "print dialog data" associated Returns the @ref overview_printing_printdata "print dialog data" associated
@@ -61,7 +61,7 @@ public:
After this function is called, a device context may be retrievable using After this function is called, a device context may be retrievable using
GetPrintDC(). GetPrintDC().
*/ */
int ShowModal(); virtual int ShowModal();
}; };
@@ -110,7 +110,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxPageSetupDialog(); virtual ~wxPageSetupDialog();
/** /**
Returns the wxPageSetupDialogData object associated with the dialog. Returns the wxPageSetupDialogData object associated with the dialog.

6
interface/wx/process.h
View File

@@ -100,7 +100,7 @@ public:
/** /**
Destroys the wxProcess object. Destroys the wxProcess object.
*/ */
~wxProcess(); virtual ~wxProcess();
/** /**
Closes the output stream (the one connected to the stdin of the child Closes the output stream (the one connected to the stdin of the child
@@ -214,7 +214,7 @@ public:
@param status @param status
The exit code of the process. The exit code of the process.
*/ */
void OnTerminate(int pid, int status); virtual void OnTerminate(int pid, int status);
/** /**
This static method replaces the standard @c popen() function: it launches This static method replaces the standard @c popen() function: it launches
@@ -290,6 +290,6 @@ public:
/** /**
Returns the process id. Returns the process id.
*/ */
int GetPid() const; int GetPid();
}; };

2
interface/wx/progdlg.h
View File

@@ -70,7 +70,7 @@ public:
/** /**
Destructor. Deletes the dialog and enables all top level windows. Destructor. Deletes the dialog and enables all top level windows.
*/ */
~wxProgressDialog(); virtual ~wxProgressDialog();
/** /**
Works like Update() but makes the gauge control run in indeterminate mode Works like Update() but makes the gauge control run in indeterminate mode

2
interface/wx/propdlg.h
View File

@@ -174,7 +174,7 @@ public:
@note On PocketPC, this does nothing, since the dialog will be shown full-screen, @note On PocketPC, this does nothing, since the dialog will be shown full-screen,
and the layout will be done when the dialog receives a size event. and the layout will be done when the dialog receives a size event.
*/ */
void LayoutDialog(int centreFlags = wxBOTH); virtual void LayoutDialog(int centreFlags = wxBOTH);
/** /**
Sets the book control used for the dialog. Sets the book control used for the dialog.

12
interface/wx/protocol/ftp.h
View File

@@ -97,13 +97,13 @@ public:
/** /**
Destructor will close the connection if connected. Destructor will close the connection if connected.
*/ */
~wxFTP(); virtual ~wxFTP();
/** /**
Aborts the download currently in process, returns @true if ok, @false Aborts the download currently in process, returns @true if ok, @false
if an error occurred. if an error occurred.
*/ */
bool Abort(); virtual bool Abort();
/** /**
Change the current FTP working directory. Change the current FTP working directory.
@@ -192,7 +192,7 @@ public:
@return Returns @NULL if an error occurred (it could be a network failure @return Returns @NULL if an error occurred (it could be a network failure
or the fact that the file doesn't exist). or the fact that the file doesn't exist).
*/ */
wxInputStream* GetInputStream(const wxString& path); virtual wxInputStream* GetInputStream(const wxString& path);
/** /**
Returns the last command result, i.e. the full server reply for the last command. Returns the last command result, i.e. the full server reply for the last command.
@@ -209,7 +209,7 @@ public:
@see wxOutputStream @see wxOutputStream
*/ */
wxOutputStream* GetOutputStream(const wxString& file); virtual wxOutputStream* GetOutputStream(const wxString& file);
/** /**
Create the specified directory in the current FTP working directory. Create the specified directory in the current FTP working directory.
@@ -266,7 +266,7 @@ public:
/** /**
Sets the password to be sent to the FTP server to be allowed to log in. Sets the password to be sent to the FTP server to be allowed to log in.
*/ */
void SetPassword(const wxString& passwd); virtual void SetPassword(const wxString& passwd);
/** /**
Sets the transfer mode to the specified one. It will be used for the next Sets the transfer mode to the specified one. It will be used for the next
@@ -279,6 +279,6 @@ public:
/** /**
Sets the user name to be sent to the FTP server to be allowed to log in. Sets the user name to be sent to the FTP server to be allowed to log in.
*/ */
void SetUser(const wxString& user); virtual void SetUser(const wxString& user);
}; };

6
interface/wx/protocol/http.h
View File

@@ -39,7 +39,7 @@ public:
The header is not case-sensitive, i.e. "CONTENT-TYPE" and "content-type" The header is not case-sensitive, i.e. "CONTENT-TYPE" and "content-type"
represent the same header. represent the same header.
*/ */
wxString GetHeader(const wxString& header); wxString GetHeader(const wxString& header) const;
/** /**
Creates a new input stream on the specified path. Creates a new input stream on the specified path.
@@ -64,14 +64,14 @@ public:
@see wxInputStream @see wxInputStream
*/ */
wxInputStream* GetInputStream(const wxString& path); virtual wxInputStream* GetInputStream(const wxString& path);
/** /**
Returns the HTTP response code returned by the server. Returns the HTTP response code returned by the server.
Please refer to RFC 2616 for the list of responses. Please refer to RFC 2616 for the list of responses.
*/ */
int GetResponse() const; int GetResponse();
/** /**
It sets data of a field to be sent during the next request to the HTTP server. It sets data of a field to be sent during the next request to the HTTP server.

6
interface/wx/protocol/protocol.h
View File

@@ -50,7 +50,7 @@ public:
/** /**
Returns the type of the content of the last opened stream. It is a mime-type. Returns the type of the content of the last opened stream. It is a mime-type.
*/ */
wxString GetContentType(); virtual wxString GetContentType();
/** /**
Returns the last occurred error. Returns the last occurred error.
@@ -87,11 +87,11 @@ public:
/** /**
Sets the authentication password. It is mainly useful when FTP is used. Sets the authentication password. It is mainly useful when FTP is used.
*/ */
void SetPassword(const wxString& user); virtual void SetPassword(const wxString& user);
/** /**
Sets the authentication user. It is mainly useful when FTP is used. Sets the authentication user. It is mainly useful when FTP is used.
*/ */
void SetUser(const wxString& user); virtual void SetUser(const wxString& user);
}; };

6
interface/wx/radiobox.h
View File

@@ -133,7 +133,7 @@ public:
/** /**
Destructor, destroying the radiobox item. Destructor, destroying the radiobox item.
*/ */
~wxRadioBox(); virtual ~wxRadioBox();
/** /**
Creates the radiobox for two-step construction. See wxRadioBox() Creates the radiobox for two-step construction. See wxRadioBox()
@@ -243,7 +243,7 @@ public:
@param n @param n
The zero-based button position. The zero-based button position.
*/ */
bool IsItemEnabled(unsigned int n) const; virtual bool IsItemEnabled(unsigned int n) const;
/** /**
Returns @true if the item is currently shown or @false if it was hidden Returns @true if the item is currently shown or @false if it was hidden
@@ -258,7 +258,7 @@ public:
@param n @param n
The zero-based button position. The zero-based button position.
*/ */
bool IsItemShown(unsigned int n) const; virtual bool IsItemShown(unsigned int n) const;
/** /**
Sets the helptext for an item. Empty string erases any existing helptext. Sets the helptext for an item. Empty string erases any existing helptext.

4
interface/wx/radiobut.h
View File

@@ -88,7 +88,7 @@ public:
/** /**
Destructor, destroying the radio button item. Destructor, destroying the radio button item.
*/ */
~wxRadioButton(); virtual ~wxRadioButton();
/** /**
Creates the choice for two-step construction. See wxRadioButton() for Creates the choice for two-step construction. See wxRadioButton() for
@@ -105,7 +105,7 @@ public:
/** /**
Returns @true if the radio button is depressed, @false otherwise. Returns @true if the radio button is depressed, @false otherwise.
*/ */
bool GetValue() const; virtual bool GetValue() const;
/** /**
Sets the radio button to selected or deselected status. This does not cause a Sets the radio button to selected or deselected status. This does not cause a

6
interface/wx/region.h
View File

@@ -198,12 +198,12 @@ public:
See @ref overview_refcount_destruct "reference-counted object destruction" for See @ref overview_refcount_destruct "reference-counted object destruction" for
more info. more info.
*/ */
~wxRegion(); virtual ~wxRegion();
/** /**
Clears the current region. Clears the current region.
*/ */
void Clear(); virtual void Clear();
/** /**
Returns a value indicating whether the given point is contained within the region. Returns a value indicating whether the given point is contained within the region.
@@ -291,7 +291,7 @@ public:
/** /**
Returns @true if the region is empty, @false otherwise. Returns @true if the region is empty, @false otherwise.
*/ */
bool IsEmpty() const; virtual bool IsEmpty() const;
/** /**
Returns @true if the region is equal to, i.e. covers the same area as, Returns @true if the region is equal to, i.e. covers the same area as,

2
interface/wx/renderer.h
View File

@@ -285,7 +285,7 @@ public:
/** /**
Virtual destructor as for any base class. Virtual destructor as for any base class.
*/ */
~wxRendererNative(); virtual ~wxRendererNative();
/** /**
Draw a check box. Draw a check box.

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

@@ -30,7 +30,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxRichTextBuffer(); virtual ~wxRichTextBuffer();
/** /**
Adds an event handler to the buffer's list of handlers. A buffer associated with Adds an event handler to the buffer's list of handlers. A buffer associated with
@@ -47,7 +47,7 @@ public:
/** /**
Adds a file handler. Adds a file handler.
*/ */
void AddHandler(wxRichTextFileHandler* handler); static void AddHandler(wxRichTextFileHandler* handler);
/** /**
Adds a paragraph of text. Adds a paragraph of text.
@@ -58,7 +58,7 @@ public:
Returns @true if the buffer is currently collapsing commands into a single Returns @true if the buffer is currently collapsing commands into a single
notional command. notional command.
*/ */
bool BatchingUndo() const; virtual bool BatchingUndo() const;
/** /**
Begins using alignment. Begins using alignment.
@@ -72,7 +72,7 @@ public:
@a cmdName should be the name of the combined command that will appear @a cmdName should be the name of the combined command that will appear
next to Undo and Redo in the edit menu. next to Undo and Redo in the edit menu.
*/ */
bool BeginBatchUndo(const wxString& cmdName); virtual bool BeginBatchUndo(const wxString& cmdName);
/** /**
Begin applying bold. Begin applying bold.
@@ -179,7 +179,7 @@ public:
/** /**
Begins using a specified style. Begins using a specified style.
*/ */
bool BeginStyle(const wxTextAttr& style); virtual bool BeginStyle(const wxTextAttr& style);
/** /**
Begins suppressing undo/redo commands. The way undo is suppressed may be Begins suppressing undo/redo commands. The way undo is suppressed may be
@@ -189,7 +189,7 @@ public:
history history
when the action is submitted to the command processor. when the action is submitted to the command processor.
*/ */
bool BeginSuppressUndo(); virtual bool BeginSuppressUndo();
/** /**
Begins applying a symbol bullet, using a character from the current font. See Begins applying a symbol bullet, using a character from the current font. See
@@ -222,12 +222,12 @@ public:
/** /**
Returns @true if content can be pasted from the clipboard. Returns @true if content can be pasted from the clipboard.
*/ */
bool CanPasteFromClipboard() const; virtual bool CanPasteFromClipboard() const;
/** /**
Cleans up the file handlers. Cleans up the file handlers.
*/ */
void CleanUpHandlers(); static void CleanUpHandlers();
/** /**
Clears the buffer. Clears the buffer.
@@ -251,12 +251,12 @@ public:
/** /**
Clears the style stack. Clears the style stack.
*/ */
void ClearStyleStack(); virtual void ClearStyleStack();
/** /**
Clones the object. Clones the object.
*/ */
wxRichTextObject* Clone() const; virtual wxRichTextObject* Clone() const;
/** /**
Copies the given buffer. Copies the given buffer.
@@ -266,7 +266,7 @@ public:
/** /**
Copy the given range to the clipboard. Copy the given range to the clipboard.
*/ */
bool CopyToClipboard(const wxRichTextRange& range); virtual bool CopyToClipboard(const wxRichTextRange& range);
/** /**
Submits a command to delete the given range. Submits a command to delete the given range.
@@ -290,12 +290,12 @@ public:
/** /**
Ends all styles that have been started with a Begin... command. Ends all styles that have been started with a Begin... command.
*/ */
bool EndAllStyles(); virtual bool EndAllStyles();
/** /**
Ends collapsing undo/redo commands, and submits the combined command. Ends collapsing undo/redo commands, and submits the combined command.
*/ */
bool EndBatchUndo(); virtual bool EndBatchUndo();
/** /**
Ends using bold. Ends using bold.
@@ -365,12 +365,12 @@ public:
/** /**
Ends the current style. Ends the current style.
*/ */
bool EndStyle(); virtual bool EndStyle();
/** /**
Ends suppressing undo/redo commands. Ends suppressing undo/redo commands.
*/ */
bool EndSuppressUndo(); virtual bool EndSuppressUndo();
/** /**
Ends using a symbol bullet. Ends using a symbol bullet.
@@ -419,7 +419,7 @@ public:
/** /**
Gets the collapsed command. Gets the collapsed command.
*/ */
wxRichTextCommand* GetBatchedCommand() const; virtual wxRichTextCommand* GetBatchedCommand() const;
/** /**
Gets the command processor. A text buffer always creates its own command Gets the command processor. A text buffer always creates its own command
@@ -499,12 +499,12 @@ public:
/** /**
Returns the current style sheet associated with the buffer, if any. Returns the current style sheet associated with the buffer, if any.
*/ */
wxRichTextStyleSheet* GetStyleSheet() const; virtual wxRichTextStyleSheet* GetStyleSheet() const;
/** /**
Get the size of the style stack, for example to check correct nesting. Get the size of the style stack, for example to check correct nesting.
*/ */
size_t GetStyleStackSize() const; virtual size_t GetStyleStackSize() const;
/** /**
Gets the attributes at the given position. Gets the attributes at the given position.
@@ -538,12 +538,12 @@ public:
loading/saving handler loading/saving handler
is initialised by default. is initialised by default.
*/ */
void InitStandardHandlers(); static void InitStandardHandlers();
/** /**
Inserts a handler at the front of the list. Inserts a handler at the front of the list.
*/ */
void InsertHandler(wxRichTextFileHandler* handler); static void InsertHandler(wxRichTextFileHandler* handler);
/** /**
Submits a command to insert the given image. Submits a command to insert the given image.
@@ -612,7 +612,7 @@ public:
/** /**
Pastes the clipboard content to the buffer at the given position. Pastes the clipboard content to the buffer at the given position.
*/ */
bool PasteFromClipboard(long position); virtual bool PasteFromClipboard(long position);
//@{ //@{
/** /**
@@ -649,12 +649,12 @@ public:
/** /**
Removes a handler. Removes a handler.
*/ */
bool RemoveHandler(const wxString& name); static bool RemoveHandler(const wxString& name);
/** /**
Clears the buffer, adds a new blank paragraph, and clears the command history. Clears the buffer, adds a new blank paragraph, and clears the command history.
*/ */
void ResetAndClearCommands(); virtual void ResetAndClearCommands();
//@{ //@{
/** /**
@@ -760,12 +760,12 @@ public:
/** /**
Submit an action immediately, or delay it according to whether collapsing is on. Submit an action immediately, or delay it according to whether collapsing is on.
*/ */
bool SubmitAction(wxRichTextAction* action); virtual bool SubmitAction(wxRichTextAction* action);
/** /**
Returns @true if undo suppression is currently on. Returns @true if undo suppression is currently on.
*/ */
bool SuppressingUndo() const; virtual bool SuppressingUndo() const;
}; };
@@ -794,17 +794,17 @@ public:
filename. By default, filename. By default,
this function checks the extension. this function checks the extension.
*/ */
bool CanHandle(const wxString& filename) const; virtual bool CanHandle(const wxString& filename) const;
/** /**
Override and return @true if this handler can load content. Override and return @true if this handler can load content.
*/ */
bool CanLoad() const; virtual bool CanLoad() const;
/** /**
Override and return @true if this handler can save content. Override and return @true if this handler can save content.
*/ */
bool CanSave() const; virtual bool CanSave() const;
/** /**
Override to load content from @a stream into @e buffer. Override to load content from @a stream into @e buffer.
@@ -846,7 +846,7 @@ public:
/** /**
Returns @true if this handler should be visible to the user. Returns @true if this handler should be visible to the user.
*/ */
bool IsVisible() const; virtual bool IsVisible() const;
//@{ //@{
/** /**
@@ -905,7 +905,7 @@ public:
load and save load and save
dialogs). dialogs).
*/ */
void SetVisible(bool visible); virtual void SetVisible(bool visible);
}; };

184
interface/wx/richtext/richtextctrl.h
View File

@@ -163,43 +163,43 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxRichTextCtrl(); virtual ~wxRichTextCtrl();
/** /**
Adds an image to the control's buffer. Adds an image to the control's buffer.
*/ */
wxRichTextRange AddImage(const wxImage& image); virtual wxRichTextRange AddImage(const wxImage& image);
/** /**
Adds a new paragraph of text to the end of the buffer. Adds a new paragraph of text to the end of the buffer.
*/ */
wxRichTextRange AddParagraph(const wxString& text); virtual wxRichTextRange AddParagraph(const wxString& text);
/** /**
Sets the insertion point to the end of the buffer and writes the text. Sets the insertion point to the end of the buffer and writes the text.
*/ */
void AppendText(const wxString& text); virtual void AppendText(const wxString& text);
/** /**
Applies the given alignment to the selection (undoable). Applies the given alignment to the selection (undoable).
For alignment values, see wxTextAttr. For alignment values, see wxTextAttr.
*/ */
bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment); virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
/** /**
Apples bold to the selection (undoable). Apples bold to the selection (undoable).
*/ */
bool ApplyBoldToSelection(); virtual bool ApplyBoldToSelection();
/** /**
Applies italic to the selection (undoable). Applies italic to the selection (undoable).
*/ */
bool ApplyItalicToSelection(); virtual bool ApplyItalicToSelection();
/** /**
Applies the given style to the selection. Applies the given style to the selection.
*/ */
bool ApplyStyle(wxRichTextStyleDefinition* def); virtual bool ApplyStyle(wxRichTextStyleDefinition* def);
/** /**
Applies the style sheet to the buffer, matching paragraph styles in the sheet Applies the style sheet to the buffer, matching paragraph styles in the sheet
@@ -214,12 +214,12 @@ public:
/** /**
Applies underline to the selection (undoable). Applies underline to the selection (undoable).
*/ */
bool ApplyUnderlineToSelection(); virtual bool ApplyUnderlineToSelection();
/** /**
Returns @true if undo commands are being batched. Returns @true if undo commands are being batched.
*/ */
bool BatchingUndo() const; virtual bool BatchingUndo() const;
/** /**
Begins using alignment Begins using alignment
@@ -230,7 +230,7 @@ public:
/** /**
Starts batching undo history for commands. Starts batching undo history for commands.
*/ */
bool BeginBatchUndo(const wxString& cmdName); virtual bool BeginBatchUndo(const wxString& cmdName);
/** /**
Begins using bold. Begins using bold.
@@ -332,12 +332,12 @@ public:
/** /**
Begins applying a style. Begins applying a style.
*/ */
bool BeginStyle(const wxTextAttr& style); virtual bool BeginStyle(const wxTextAttr& style);
/** /**
Starts suppressing undo history for commands. Starts suppressing undo history for commands.
*/ */
bool BeginSuppressUndo(); virtual bool BeginSuppressUndo();
/** /**
Begins applying a symbol bullet, using a character from the current font. See Begins applying a symbol bullet, using a character from the current font. See
@@ -370,37 +370,37 @@ public:
/** /**
Returns @true if selected content can be copied to the clipboard. Returns @true if selected content can be copied to the clipboard.
*/ */
bool CanCopy() const; virtual bool CanCopy() const;
/** /**
Returns @true if selected content can be copied to the clipboard and deleted. Returns @true if selected content can be copied to the clipboard and deleted.
*/ */
bool CanCut() const; virtual bool CanCut() const;
/** /**
Returns @true if selected content can be deleted. Returns @true if selected content can be deleted.
*/ */
bool CanDeleteSelection() const; virtual bool CanDeleteSelection() const;
/** /**
Returns @true if the clipboard content can be pasted to the buffer. Returns @true if the clipboard content can be pasted to the buffer.
*/ */
bool CanPaste() const; virtual bool CanPaste() const;
/** /**
Returns @true if there is a command in the command history that can be redone. Returns @true if there is a command in the command history that can be redone.
*/ */
bool CanRedo() const; virtual bool CanRedo() const;
/** /**
Returns @true if there is a command in the command history that can be undone. Returns @true if there is a command in the command history that can be undone.
*/ */
bool CanUndo() const; virtual bool CanUndo() const;
/** /**
Clears the buffer content, leaving a single empty paragraph. Cannot be undone. Clears the buffer content, leaving a single empty paragraph. Cannot be undone.
*/ */
void Clear(); virtual void Clear();
//@{ //@{
/** /**
@@ -419,12 +419,12 @@ public:
/** /**
Sends the event to the control. Sends the event to the control.
*/ */
void Command(wxCommandEvent& event); virtual void Command(wxCommandEvent& event);
/** /**
Copies the selected content (if any) to the clipboard. Copies the selected content (if any) to the clipboard.
*/ */
void Copy(); virtual void Copy();
/** /**
Creates the underlying window. Creates the underlying window.
@@ -441,12 +441,12 @@ public:
Copies the selected content (if any) to the clipboard and deletes the selection. Copies the selected content (if any) to the clipboard and deletes the selection.
This is undoable. This is undoable.
*/ */
void Cut(); virtual void Cut();
/** /**
Deletes the content within the given range. Deletes the content within the given range.
*/ */
bool Delete(const wxRichTextRange& range); virtual bool Delete(const wxRichTextRange& range);
/** /**
Deletes content if there is a selection, e.g. when pressing a key. Deletes content if there is a selection, e.g. when pressing a key.
@@ -458,13 +458,13 @@ public:
/** /**
Deletes the content in the selection, if any. This is undoable. Deletes the content in the selection, if any. This is undoable.
*/ */
void DeleteSelection(); virtual void DeleteSelection();
/** /**
Sets the buffer's modified status to @false, and clears the buffer's command Sets the buffer's modified status to @false, and clears the buffer's command
history. history.
*/ */
void DiscardEdits(); virtual void DiscardEdits();
/** /**
Currently this simply returns @c wxSize(10, 10). Currently this simply returns @c wxSize(10, 10).
@@ -479,12 +479,12 @@ public:
/** /**
Ends application of all styles in the current style stack. Ends application of all styles in the current style stack.
*/ */
bool EndAllStyles(); virtual bool EndAllStyles();
/** /**
Ends batching undo command history. Ends batching undo command history.
*/ */
bool EndBatchUndo(); virtual bool EndBatchUndo();
/** /**
Ends using bold. Ends using bold.
@@ -549,12 +549,12 @@ public:
/** /**
Ends the current style. Ends the current style.
*/ */
bool EndStyle(); virtual bool EndStyle();
/** /**
Ends suppressing undo command history. Ends suppressing undo command history.
*/ */
bool EndSuppressUndo(); virtual bool EndSuppressUndo();
/** /**
Ends applying a symbol bullet. Ends applying a symbol bullet.
@@ -588,7 +588,7 @@ public:
Helper function for finding the caret position for the next word. Direction Helper function for finding the caret position for the next word. Direction
is 1 (forward) or -1 (backwards). is 1 (forward) or -1 (backwards).
*/ */
long FindNextWordPosition(int direction = 1) const; virtual long FindNextWordPosition(int direction = 1) const;
/** /**
Call this function to prevent refresh and allow fast updates, and then Thaw() to Call this function to prevent refresh and allow fast updates, and then Thaw() to
@@ -660,22 +660,22 @@ public:
/** /**
Returns the current insertion point. Returns the current insertion point.
*/ */
long GetInsertionPoint() const; virtual long GetInsertionPoint() const;
/** /**
Returns the last position in the buffer. Returns the last position in the buffer.
*/ */
wxTextPos GetLastPosition() const; virtual wxTextPos GetLastPosition() const;
/** /**
Returns the length of the specified line in characters. Returns the length of the specified line in characters.
*/ */
int GetLineLength(long lineNo) const; virtual int GetLineLength(long lineNo) const;
/** /**
Returns the text for the given line. Returns the text for the given line.
*/ */
wxString GetLineText(long lineNo) const; virtual wxString GetLineText(long lineNo) const;
/** /**
Transforms physical window position to logical (unscrolled) position. Transforms physical window position to logical (unscrolled) position.
@@ -685,7 +685,7 @@ public:
/** /**
Returns the number of lines in the buffer. Returns the number of lines in the buffer.
*/ */
int GetNumberOfLines() const; virtual int GetNumberOfLines() const;
/** /**
Transforms logical (unscrolled) position to physical window position. Transforms logical (unscrolled) position to physical window position.
@@ -697,7 +697,7 @@ public:
The end point of range is specified as the last character position of the span The end point of range is specified as the last character position of the span
of text, plus one. of text, plus one.
*/ */
wxString GetRange(long from, long to) const; virtual wxString GetRange(long from, long to) const;
/** /**
Returns the range of the current selection. Returns the range of the current selection.
@@ -705,7 +705,7 @@ public:
of text, plus one. of text, plus one.
If the return values @a from and @a to are the same, there is no selection. If the return values @a from and @a to are the same, there is no selection.
*/ */
void GetSelection(long* from, long* to) const; virtual void GetSelection(long* from, long* to) const;
/** /**
Returns the selection range in character positions. -1, -1 means no selection. Returns the selection range in character positions. -1, -1 means no selection.
@@ -715,7 +715,7 @@ public:
/** /**
Returns the text within the current selection range, if any. Returns the text within the current selection range, if any.
*/ */
wxString GetStringSelection() const; virtual wxString GetStringSelection() const;
/** /**
Gets the attributes at the given position. Gets the attributes at the given position.
@@ -725,7 +725,7 @@ public:
the character the character
or paragraph style alone, use GetUncombinedStyle(). or paragraph style alone, use GetUncombinedStyle().
*/ */
bool GetStyle(long position, wxTextAttr& style); virtual bool GetStyle(long position, wxTextAttr& style);
/** /**
Gets the attributes common to the specified range. Attributes that differ in Gets the attributes common to the specified range. Attributes that differ in
@@ -753,12 +753,12 @@ public:
will fetch will fetch
the paragraph attributes. Otherwise, it will return the character attributes. the paragraph attributes. Otherwise, it will return the character attributes.
*/ */
bool GetUncombinedStyle(long position, wxTextAttr& style); virtual bool GetUncombinedStyle(long position, wxTextAttr& style);
/** /**
Returns the content of the entire control as a string. Returns the content of the entire control as a string.
*/ */
wxString GetValue() const; virtual wxString GetValue() const;
/** /**
Internal helper function returning the line for the visible caret position. If Internal helper function returning the line for the visible caret position. If
@@ -791,7 +791,7 @@ public:
/** /**
Returns @true if there is a selection. Returns @true if there is a selection.
*/ */
bool HasSelection() const; virtual bool HasSelection() const;
//@{ //@{
/** /**
@@ -830,7 +830,7 @@ public:
/** /**
Returns @true if the control is editable. Returns @true if the control is editable.
*/ */
bool IsEditable() const; virtual bool IsEditable() const;
/** /**
Returns @true if Freeze has been called without a Thaw. Returns @true if Freeze has been called without a Thaw.
@@ -840,7 +840,7 @@ public:
/** /**
Returns @true if the buffer has been modified. Returns @true if the buffer has been modified.
*/ */
bool IsModified() const; virtual bool IsModified() const;
/** /**
Returns @true if the control is multiline. Returns @true if the control is multiline.
@@ -856,22 +856,22 @@ public:
Returns @true if all of the selection is aligned according to the specified Returns @true if all of the selection is aligned according to the specified
flag. flag.
*/ */
bool IsSelectionAligned(wxTextAttrAlignment alignment) const; virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
/** /**
Returns @true if all of the selection is bold. Returns @true if all of the selection is bold.
*/ */
bool IsSelectionBold() const; virtual bool IsSelectionBold();
/** /**
Returns @true if all of the selection is italic. Returns @true if all of the selection is italic.
*/ */
bool IsSelectionItalics() const; virtual bool IsSelectionItalics();
/** /**
Returns @true if all of the selection is underlined. Returns @true if all of the selection is underlined.
*/ */
bool IsSelectionUnderlined() const; virtual bool IsSelectionUnderlined();
/** /**
Returns @true if the control is single-line. Currently wxRichTextCtrl does not Returns @true if the control is single-line. Currently wxRichTextCtrl does not
@@ -882,14 +882,14 @@ public:
/** /**
Helper function implementing keyboard navigation. Helper function implementing keyboard navigation.
*/ */
bool KeyboardNavigate(int keyCode, int flags); virtual bool KeyboardNavigate(int keyCode, int flags);
/** /**
Lays out the buffer, which must be done before certain operations, such as Lays out the buffer, which must be done before certain operations, such as
setting the caret position. This function should not normally be required by the setting the caret position. This function should not normally be required by the
application. application.
*/ */
bool LayoutContent(bool onlyVisibleRect = false); virtual bool LayoutContent(bool onlyVisibleRect = false);
/** /**
Inserts a line break at the current insertion point. A line break forces Inserts a line break at the current insertion point. A line break forces
@@ -898,7 +898,7 @@ public:
wxRichTextLineBreakChar to text content, wxRichTextLineBreakChar to text content,
or by typing Shift-Return. or by typing Shift-Return.
*/ */
bool LineBreak(); virtual bool LineBreak();
/** /**
Loads content into the control's buffer using the given type. If the specified Loads content into the control's buffer using the given type. If the specified
@@ -912,12 +912,12 @@ public:
/** /**
Marks the buffer as modified. Marks the buffer as modified.
*/ */
void MarkDirty(); virtual void MarkDirty();
/** /**
Move the caret to the given character position. Move the caret to the given character position.
*/ */
bool MoveCaret(long pos, bool showAtLineStart = false); virtual bool MoveCaret(long pos, bool showAtLineStart = false);
/** /**
Move the caret one visual step forward: this may mean setting a flag Move the caret one visual step forward: this may mean setting a flag
@@ -936,57 +936,57 @@ public:
/** /**
Moves the caret down. Moves the caret down.
*/ */
bool MoveDown(int noLines = 1, int flags = 0); virtual bool MoveDown(int noLines = 1, int flags = 0);
/** /**
Moves to the end of the buffer. Moves to the end of the buffer.
*/ */
bool MoveEnd(int flags = 0); virtual bool MoveEnd(int flags = 0);
/** /**
Moves to the start of the buffer. Moves to the start of the buffer.
*/ */
bool MoveHome(int flags = 0); virtual bool MoveHome(int flags = 0);
/** /**
Moves left. Moves left.
*/ */
bool MoveLeft(int noPositions = 1, int flags = 0); virtual bool MoveLeft(int noPositions = 1, int flags = 0);
/** /**
Moves right. Moves right.
*/ */
bool MoveRight(int noPositions = 1, int flags = 0); virtual bool MoveRight(int noPositions = 1, int flags = 0);
/** /**
Moves to the end of the line. Moves to the end of the line.
*/ */
bool MoveToLineEnd(int flags = 0); virtual bool MoveToLineEnd(int flags = 0);
/** /**
Moves to the start of the line. Moves to the start of the line.
*/ */
bool MoveToLineStart(int flags = 0); virtual bool MoveToLineStart(int flags = 0);
/** /**
Moves to the end of the paragraph. Moves to the end of the paragraph.
*/ */
bool MoveToParagraphEnd(int flags = 0); virtual bool MoveToParagraphEnd(int flags = 0);
/** /**
Moves to the start of the paragraph. Moves to the start of the paragraph.
*/ */
bool MoveToParagraphStart(int flags = 0); virtual bool MoveToParagraphStart(int flags = 0);
/** /**
Moves up. Moves up.
*/ */
bool MoveUp(int noLines = 1, int flags = 0); virtual bool MoveUp(int noLines = 1, int flags = 0);
/** /**
Inserts a new paragraph at the current insertion point. See also LineBreak(). Inserts a new paragraph at the current insertion point. See also LineBreak().
*/ */
bool Newline(); virtual bool Newline();
//@{ //@{
/** /**
@@ -1098,33 +1098,33 @@ public:
/** /**
Moves one or more pages down. Moves one or more pages down.
*/ */
bool PageDown(int noPages = 1, int flags = 0); virtual bool PageDown(int noPages = 1, int flags = 0);
/** /**
Moves one or more pages up. Moves one or more pages up.
*/ */
bool PageUp(int noPages = 1, int flags = 0); virtual bool PageUp(int noPages = 1, int flags = 0);
/** /**
Paints the background. Paints the background.
*/ */
void PaintBackground(wxDC& dc); virtual void PaintBackground(wxDC& dc);
/** /**
Pastes content from the clipboard to the buffer. Pastes content from the clipboard to the buffer.
*/ */
void Paste(); virtual void Paste();
/** /**
Internal function to position the visible caret according to the current caret Internal function to position the visible caret according to the current caret
position. position.
*/ */
void PositionCaret(); virtual void PositionCaret();
/** /**
Converts a text position to zero-based column and line numbers. Converts a text position to zero-based column and line numbers.
*/ */
bool PositionToXY(long pos, long* x, long* y) const; virtual bool PositionToXY(long pos, long* x, long* y) const;
//@{ //@{
/** /**
@@ -1154,18 +1154,18 @@ public:
/** /**
Redoes the current command. Redoes the current command.
*/ */
void Redo(); virtual void Redo();
/** /**
Removes the content in the specified range. Removes the content in the specified range.
*/ */
void Remove(long from, long to); virtual void Remove(long from, long to);
/** /**
Replaces the content in the specified range with the string specified by @e Replaces the content in the specified range with the string specified by @e
value. value.
*/ */
void Replace(long from, long to, const wxString& value); virtual void Replace(long from, long to, const wxString& value);
/** /**
Saves the buffer content using the given type. If the specified type Saves the buffer content using the given type. If the specified type
@@ -1178,17 +1178,17 @@ public:
/** /**
Scrolls @a position into view. This function takes a caret position. Scrolls @a position into view. This function takes a caret position.
*/ */
bool ScrollIntoView(long position, int keyCode); virtual bool ScrollIntoView(long position, int keyCode);
/** /**
Selects all the text in the buffer. Selects all the text in the buffer.
*/ */
void SelectAll(); virtual void SelectAll();
/** /**
Cancels any selection. Cancels any selection.
*/ */
void SelectNone(); virtual void SelectNone();
/** /**
Sets @a attr as the default style and tells the control that the UI should Sets @a attr as the default style and tells the control that the UI should
@@ -1204,7 +1204,7 @@ public:
only affects the style currently being applied (for example, setting the default only affects the style currently being applied (for example, setting the default
style to bold will cause subsequently inserted text to be bold). style to bold will cause subsequently inserted text to be bold).
*/ */
void SetBasicStyle(const wxTextAttr& style); virtual void SetBasicStyle(const wxTextAttr& style);
/** /**
The caret position is the character position just before the caret. The caret position is the character position just before the caret.
@@ -1218,7 +1218,7 @@ public:
inserted inserted
text is displayed. text is displayed.
*/ */
bool SetDefaultStyle(const wxTextAttr& style); virtual bool SetDefaultStyle(const wxTextAttr& style);
/** /**
Sets the default style to the style under the cursor. Sets the default style to the style under the cursor.
@@ -1234,7 +1234,7 @@ public:
/** /**
Makes the control editable, or not. Makes the control editable, or not.
*/ */
void SetEditable(bool editable); virtual void SetEditable(bool editable);
/** /**
Sets the current filename. Sets the current filename.
@@ -1245,7 +1245,7 @@ public:
Sets the font, and also the basic and default attributes (see Sets the font, and also the basic and default attributes (see
wxRichTextCtrl::SetDefaultStyle). wxRichTextCtrl::SetDefaultStyle).
*/ */
bool SetFont(const wxFont& font); virtual bool SetFont(const wxFont& font);
/** /**
Sets flags that change the behaviour of loading or saving. See the Sets flags that change the behaviour of loading or saving. See the
@@ -1257,12 +1257,12 @@ public:
/** /**
Sets the insertion point. Sets the insertion point.
*/ */
void SetInsertionPoint(long pos); virtual void SetInsertionPoint(long pos);
/** /**
Sets the insertion point to the end of the text control. Sets the insertion point to the end of the text control.
*/ */
void SetInsertionPointEnd(); virtual void SetInsertionPointEnd();
//@{ //@{
/** /**
@@ -1297,7 +1297,7 @@ public:
So, for example, to set the selection for a character at position 5, use the So, for example, to set the selection for a character at position 5, use the
range (5,6). range (5,6).
*/ */
void SetSelection(long from, long to); virtual void SetSelection(long from, long to);
/** /**
Sets the selection to the given range. Sets the selection to the given range.
@@ -1371,17 +1371,17 @@ public:
/** /**
A helper function setting up scrollbars, for example after a resize. A helper function setting up scrollbars, for example after a resize.
*/ */
void SetupScrollbars(bool atTop = false); virtual void SetupScrollbars(bool atTop = false);
/** /**
Scrolls the buffer so that the given position is in view. Scrolls the buffer so that the given position is in view.
*/ */
void ShowPosition(long pos); virtual void ShowPosition(long pos);
/** /**
Returns @true if undo history suppression is on. Returns @true if undo history suppression is on.
*/ */
bool SuppressingUndo() const; virtual bool SuppressingUndo() const;
/** /**
Call this function to end a Freeze and refresh the display. Call this function to end a Freeze and refresh the display.
@@ -1391,17 +1391,17 @@ public:
/** /**
Undoes the command at the top of the command history, if there is one. Undoes the command at the top of the command history, if there is one.
*/ */
void Undo(); virtual void Undo();
/** /**
Moves a number of words to the left. Moves a number of words to the left.
*/ */
bool WordLeft(int noWords = 1, int flags = 0); virtual bool WordLeft(int noWords = 1, int flags = 0);
/** /**
Move a nuber of words to the right. Move a nuber of words to the right.
*/ */
bool WordRight(int noWords = 1, int flags = 0); virtual bool WordRight(int noWords = 1, int flags = 0);
//@{ //@{
/** /**
@@ -1420,11 +1420,11 @@ public:
/** /**
Writes text at the current position. Writes text at the current position.
*/ */
void WriteText(const wxString& text); virtual void WriteText(const wxString& text);
/** /**
Translates from column and line number to position. Translates from column and line number to position.
*/ */
long XYToPosition(long x, long y) const; virtual long XYToPosition(long x, long y) const;
}; };

30
interface/wx/richtext/richtextformatdlg.h
View File

@@ -32,7 +32,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxRichTextFormattingDialogFactory(); virtual ~wxRichTextFormattingDialogFactory();
/** /**
Creates the main dialog buttons. Creates the main dialog buttons.
@@ -142,7 +142,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxRichTextFormattingDialog(); virtual ~wxRichTextFormattingDialog();
/** /**
Apply attributes to the given range, only changing attributes that need to be Apply attributes to the given range, only changing attributes that need to be
@@ -173,22 +173,22 @@ public:
/** /**
Helper for pages to get the top-level dialog. Helper for pages to get the top-level dialog.
*/ */
wxRichTextFormattingDialog* GetDialog(wxWindow* win); static wxRichTextFormattingDialog* GetDialog(wxWindow* win);
/** /**
Helper for pages to get the attributes. Helper for pages to get the attributes.
*/ */
wxTextAttr* GetDialogAttributes(wxWindow* win); static wxTextAttr* GetDialogAttributes(wxWindow* win);
/** /**
Helper for pages to get the style. Helper for pages to get the style.
*/ */
wxRichTextStyleDefinition* GetDialogStyleDefinition(wxWindow* win); static wxRichTextStyleDefinition* GetDialogStyleDefinition(wxWindow* win);
/** /**
Returns the object to be used to customize the dialog and provide pages. Returns the object to be used to customize the dialog and provide pages.
*/ */
wxRichTextFormattingDialogFactory* GetFormattingDialogFactory(); static wxRichTextFormattingDialogFactory* GetFormattingDialogFactory();
/** /**
Returns the image list associated with the dialog, used for example if showing Returns the image list associated with the dialog, used for example if showing
@@ -201,17 +201,17 @@ public:
that do not have common values in the given range that do not have common values in the given range
will be omitted from the style's flags. will be omitted from the style's flags.
*/ */
bool GetStyle(wxRichTextCtrl* ctrl, const wxRichTextRange& range); virtual bool GetStyle(wxRichTextCtrl* ctrl, const wxRichTextRange& range);
/** /**
Gets the associated style definition, if any. Gets the associated style definition, if any.
*/ */
wxRichTextStyleDefinition* GetStyleDefinition() const; virtual wxRichTextStyleDefinition* GetStyleDefinition() const;
/** /**
Gets the associated style sheet, if any. Gets the associated style sheet, if any.
*/ */
wxRichTextStyleSheet* GetStyleSheet() const; virtual wxRichTextStyleSheet* GetStyleSheet() const;
/** /**
Sets the attributes to be edited. Sets the attributes to be edited.
@@ -223,7 +223,7 @@ public:
creation. creation.
It deletes the existing factory object. It deletes the existing factory object.
*/ */
void SetFormattingDialogFactory(wxRichTextFormattingDialogFactory* factory); static void SetFormattingDialogFactory(wxRichTextFormattingDialogFactory* factory);
/** /**
Sets the image list associated with the dialog's property sheet. Sets the image list associated with the dialog's property sheet.
@@ -233,19 +233,19 @@ public:
/** /**
Sets the attributes and optionally updates the display, if @a update is @true. Sets the attributes and optionally updates the display, if @a update is @true.
*/ */
bool SetStyle(const wxTextAttr& style, bool update = true); virtual bool SetStyle(const wxTextAttr& style, bool update = true);
/** /**
Sets the style definition and optionally update the display, if @a update is @c Sets the style definition and optionally update the display, if @a update is @c
@true. @true.
*/ */
bool SetStyleDefinition(const wxRichTextStyleDefinition& styleDef, virtual bool SetStyleDefinition(const wxRichTextStyleDefinition& styleDef,
wxRichTextStyleSheet* sheet, wxRichTextStyleSheet* sheet,
bool update = true); bool update = true);
/** /**
Updates the display. Updates the display.
*/ */
bool UpdateDisplay(); virtual bool UpdateDisplay();
}; };

4
interface/wx/richtext/richtexthtml.h
View File

@@ -69,7 +69,7 @@ public:
/** /**
Returns the mapping for converting point sizes to HTML font sizes. Returns the mapping for converting point sizes to HTML font sizes.
*/ */
wxArrayInt GetFontSizeMapping(); wxArrayInt GetFontSizeMapping() const;
/** /**
Returns the directory used to store temporary image files. Returns the directory used to store temporary image files.
@@ -85,7 +85,7 @@ public:
Reset the file counter, in case, for example, the same names are required each Reset the file counter, in case, for example, the same names are required each
time time
*/ */
void SetFileCounter(int counter); static void SetFileCounter(int counter);
/** /**
Sets the mapping for converting point sizes to HTML font sizes. Sets the mapping for converting point sizes to HTML font sizes.

6
interface/wx/richtext/richtextprint.h
View File

@@ -201,17 +201,17 @@ public:
/** /**
Returns @true if the given page exists in the printout. Returns @true if the given page exists in the printout.
*/ */
bool HasPage(int page); virtual bool HasPage(int page);
/** /**
Prepares for printing, laying out the buffer and calculating pagination. Prepares for printing, laying out the buffer and calculating pagination.
*/ */
void OnPreparePrinting(); virtual void OnPreparePrinting();
/** /**
Does the actual printing for this page. Does the actual printing for this page.
*/ */
bool OnPrintPage(int page); virtual bool OnPrintPage(int page);
/** /**
Sets the header and footer data associated with the printout. Sets the header and footer data associated with the printout.

2
interface/wx/richtext/richtextstyledlg.h
View File

@@ -161,7 +161,7 @@ public:
/** /**
Determines whether tooltips will be shown. Determines whether tooltips will be shown.
*/ */
void SetShowToolTips(bool show); static void SetShowToolTips(bool show);
/** /**
Sets the associated style sheet. Sets the associated style sheet.

14
interface/wx/richtext/richtextstyles.h
View File

@@ -124,7 +124,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxRichTextStyleDefinition(); virtual ~wxRichTextStyleDefinition();
/** /**
Returns the style on which this style is based. Returns the style on which this style is based.
@@ -198,7 +198,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxRichTextParagraphStyleDefinition(); virtual ~wxRichTextParagraphStyleDefinition();
/** /**
Returns the style that should normally follow this style. Returns the style that should normally follow this style.
@@ -242,7 +242,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxRichTextStyleListBox(); virtual ~wxRichTextStyleListBox();
/** /**
Applies the @e ith style to the associated rich text control. Applies the @e ith style to the associated rich text control.
@@ -364,7 +364,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxRichTextStyleComboCtrl(); virtual ~wxRichTextStyleComboCtrl();
/** /**
Returns the wxRichTextCtrl associated with this control. Returns the wxRichTextCtrl associated with this control.
@@ -414,7 +414,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxRichTextCharacterStyleDefinition(); virtual ~wxRichTextCharacterStyleDefinition();
}; };
@@ -453,7 +453,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxRichTextListStyleDefinition(); virtual ~wxRichTextListStyleDefinition();
/** /**
This function combines the given paragraph style with the list style's base This function combines the given paragraph style with the list style's base
@@ -545,7 +545,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxRichTextStyleSheet(); virtual ~wxRichTextStyleSheet();
/** /**
Adds a definition to the character style list. Adds a definition to the character style list.

4
interface/wx/richtext/richtextxml.h
View File

@@ -30,12 +30,12 @@ public:
/** /**
Returns @true. Returns @true.
*/ */
bool CanLoad() const; virtual bool CanLoad() const;
/** /**
Returns @true. Returns @true.
*/ */
bool CanSave() const; virtual bool CanSave() const;
/** /**
Creates XML code for a given character or paragraph style. Creates XML code for a given character or paragraph style.

18
interface/wx/sashwin.h
View File

@@ -79,27 +79,27 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxSashWindow(); virtual ~wxSashWindow();
/** /**
Gets the maximum window size in the x direction. Gets the maximum window size in the x direction.
*/ */
int GetMaximumSizeX() const; virtual int GetMaximumSizeX() const;
/** /**
Gets the maximum window size in the y direction. Gets the maximum window size in the y direction.
*/ */
int GetMaximumSizeY() const; virtual int GetMaximumSizeY() const;
/** /**
Gets the minimum window size in the x direction. Gets the minimum window size in the x direction.
*/ */
int GetMinimumSizeX(); virtual int GetMinimumSizeX() const;
/** /**
Gets the minimum window size in the y direction. Gets the minimum window size in the y direction.
*/ */
int GetMinimumSizeY() const; virtual int GetMinimumSizeY() const;
/** /**
Returns @true if a sash is visible on the given edge, @false otherwise. Returns @true if a sash is visible on the given edge, @false otherwise.
@@ -125,22 +125,22 @@ public:
/** /**
Sets the maximum window size in the x direction. Sets the maximum window size in the x direction.
*/ */
void SetMaximumSizeX(int min); virtual void SetMaximumSizeX(int min);
/** /**
Sets the maximum window size in the y direction. Sets the maximum window size in the y direction.
*/ */
void SetMaximumSizeY(int min); virtual void SetMaximumSizeY(int min);
/** /**
Sets the minimum window size in the x direction. Sets the minimum window size in the x direction.
*/ */
void SetMinimumSizeX(int min); virtual void SetMinimumSizeX(int min);
/** /**
Sets the minimum window size in the y direction. Sets the minimum window size in the y direction.
*/ */
void SetMinimumSizeY(int min); virtual void SetMinimumSizeY(int min);
/** /**
Call this function to give the sash a border, or remove the border. Call this function to give the sash a border, or remove the border.

18
interface/wx/sckipc.h
View File

@@ -34,7 +34,7 @@ public:
number. @false is returned if the call failed (for example, the port number. @false is returned if the call failed (for example, the port
number is already in use). number is already in use).
*/ */
bool Create(const wxString& service); virtual bool Create(const wxString& service);
/** /**
When a client calls @b MakeConnection, the server receives the When a client calls @b MakeConnection, the server receives the
@@ -89,9 +89,9 @@ public:
the OnMakeConnection() member to return your own the OnMakeConnection() member to return your own
derived connection object. derived connection object.
*/ */
wxConnectionBase* MakeConnection(const wxString& host, virtual wxConnectionBase* MakeConnection(const wxString& host,
const wxString& service, const wxString& service,
const wxString& topic); const wxString& topic);
/** /**
The type of wxTCPConnection returned from a MakeConnection() call can The type of wxTCPConnection returned from a MakeConnection() call can
@@ -103,12 +103,12 @@ public:
as wxTCPConnection::OnAdvise. You may also want to as wxTCPConnection::OnAdvise. You may also want to
store application-specific data in instances of the new class. store application-specific data in instances of the new class.
*/ */
wxConnectionBase* OnMakeConnection(); virtual wxConnectionBase* OnMakeConnection();
/** /**
Returns @true if this is a valid host name, @false otherwise. Returns @true if this is a valid host name, @false otherwise.
*/ */
bool ValidHost(const wxString& host); virtual bool ValidHost(const wxString& host);
}; };
@@ -182,7 +182,7 @@ public:
side of the connection having called @b Disconnect. Returns @true if side of the connection having called @b Disconnect. Returns @true if
successful. successful.
*/ */
bool Disconnect(); virtual bool Disconnect();
//@{ //@{
/** /**
@@ -291,13 +291,13 @@ public:
member to be called. Returns @true if the server okays it, @false member to be called. Returns @true if the server okays it, @false
otherwise. otherwise.
*/ */
bool StartAdvise(const wxString& item); virtual bool StartAdvise(const wxString& item);
/** /**
Called by the client application to ask if an advise loop can be Called by the client application to ask if an advise loop can be
stopped. Causes the server connection's OnStopAdvise() member stopped. Causes the server connection's OnStopAdvise() member
to be called. Returns @true if the server okays it, @false otherwise. to be called. Returns @true if the server okays it, @false otherwise.
*/ */
bool StopAdvise(const wxString& item); virtual bool StopAdvise(const wxString& item);
}; };

12
interface/wx/scrolbar.h
View File

@@ -67,7 +67,7 @@ public:
/** /**
Destructor, destroying the scrollbar. Destructor, destroying the scrollbar.
*/ */
~wxScrollBar(); virtual ~wxScrollBar();
/** /**
Scrollbar creation function called by the scrollbar constructor. Scrollbar creation function called by the scrollbar constructor.
@@ -87,28 +87,28 @@ public:
@see SetScrollbar() @see SetScrollbar()
*/ */
int GetPageSize() const; virtual int GetPageSize() const;
/** /**
Returns the length of the scrollbar. Returns the length of the scrollbar.
@see SetScrollbar() @see SetScrollbar()
*/ */
int GetRange() const; virtual int GetRange() const;
/** /**
Returns the current position of the scrollbar thumb. Returns the current position of the scrollbar thumb.
@see SetThumbPosition() @see SetThumbPosition()
*/ */
int GetThumbPosition() const; virtual int GetThumbPosition() const;
/** /**
Returns the thumb or 'view' size. Returns the thumb or 'view' size.
@see SetScrollbar() @see SetScrollbar()
*/ */
int GetThumbSize() const; virtual int GetThumbSize() const;
/** /**
Sets the scrollbar properties. Sets the scrollbar properties.
@@ -143,6 +143,6 @@ public:
@see GetThumbPosition() @see GetThumbPosition()
*/ */
void SetThumbPosition(int viewStart); virtual void SetThumbPosition(int viewStart);
}; };

38
interface/wx/sizer.h
View File

@@ -122,7 +122,7 @@ public:
/** /**
Deletes the user data and subsizer, if any. Deletes the user data and subsizer, if any.
*/ */
~wxSizerItem(); virtual ~wxSizerItem();
/** /**
Calculates the minimum desired size for the item, including any space Calculates the minimum desired size for the item, including any space
@@ -134,7 +134,7 @@ public:
Destroy the window or the windows in a subsizer, depending on the type Destroy the window or the windows in a subsizer, depending on the type
of item. of item.
*/ */
void DeleteWindows(); virtual void DeleteWindows();
/** /**
Enable deleting the SizerItem without destroying the contained sizer. Enable deleting the SizerItem without destroying the contained sizer.
@@ -195,12 +195,12 @@ public:
/** /**
Get the rectangle of the item on the parent window, excluding borders. Get the rectangle of the item on the parent window, excluding borders.
*/ */
wxRect GetRect(); virtual wxRect GetRect();
/** /**
Get the current size of the item, as set in the last Layout. Get the current size of the item, as set in the last Layout.
*/ */
wxSize GetSize() const; virtual wxSize GetSize() const;
/** /**
If this item is tracking a sizer, return it. @NULL otherwise. If this item is tracking a sizer, return it. @NULL otherwise.
@@ -260,7 +260,7 @@ public:
adjust the position and size of the item to be within that space adjust the position and size of the item to be within that space
taking alignment and borders into account. taking alignment and borders into account.
*/ */
void SetDimension(const wxPoint& pos, const wxSize& size); virtual void SetDimension(const wxPoint& pos, const wxSize& size);
/** /**
Set the flag item attribute. Set the flag item attribute.
@@ -293,6 +293,7 @@ public:
/** /**
Set the sizer tracked by this item. Set the sizer tracked by this item.
@deprecated @todo provide deprecation description
*/ */
void SetSizer(wxSizer* sizer); void SetSizer(wxSizer* sizer);
@@ -789,7 +790,7 @@ public:
/** /**
The destructor. The destructor.
*/ */
~wxSizer(); virtual ~wxSizer();
/** /**
Appends a child to the sizer. Appends a child to the sizer.
@@ -974,7 +975,7 @@ public:
Detaches all children from the sizer. If @a delete_windows is @true then Detaches all children from the sizer. If @a delete_windows is @true then
child windows will also be deleted. child windows will also be deleted.
*/ */
void Clear(bool delete_windows = false); virtual void Clear(bool delete_windows = false);
/** /**
Computes client area size for @a window so that it matches the sizer's Computes client area size for @a window so that it matches the sizer's
@@ -1012,7 +1013,7 @@ public:
@see Remove() @see Remove()
*/ */
bool Detach(wxWindow* window); virtual bool Detach(wxWindow* window);
/** /**
Detach the child @a sizer from the sizer without destroying it. Detach the child @a sizer from the sizer without destroying it.
@@ -1024,7 +1025,7 @@ public:
@see Remove() @see Remove()
*/ */
bool Detach(wxSizer* sizer); virtual bool Detach(wxSizer* sizer);
/** /**
Detach a item at position @a index from the sizer without destroying it. Detach a item at position @a index from the sizer without destroying it.
@@ -1126,12 +1127,12 @@ public:
/** /**
Returns the current position of the sizer. Returns the current position of the sizer.
*/ */
wxPoint GetPosition(); wxPoint GetPosition() const;
/** /**
Returns the current size of the sizer. Returns the current size of the sizer.
*/ */
wxSize GetSize(); wxSize GetSize() const;
/** /**
Hides the child @a window. Hides the child @a window.
@@ -1257,7 +1258,7 @@ public:
keeping keeping
the current dimension. the current dimension.
*/ */
void Layout(); virtual void Layout();
/** /**
Same as Add(), but prepends the items to the beginning of the Same as Add(), but prepends the items to the beginning of the
@@ -1349,7 +1350,7 @@ public:
@return @true if the child item was found and removed, @false otherwise. @return @true if the child item was found and removed, @false otherwise.
*/ */
bool Remove(wxSizer* sizer); virtual bool Remove(wxSizer* sizer);
/** /**
Removes a child from the sizer and destroys it if it is a sizer or a Removes a child from the sizer and destroys it if it is a sizer or a
@@ -1414,7 +1415,7 @@ public:
Returns @true if the child item was found and removed, @false otherwise. Returns @true if the child item was found and removed, @false otherwise.
*/ */
bool Replace(size_t index, wxSizerItem* newitem); virtual bool Replace(size_t index, wxSizerItem* newitem);
/** /**
Call this to force the sizer to take the given dimension and thus force Call this to force the sizer to take the given dimension and thus force
@@ -1496,6 +1497,7 @@ public:
appropriately. appropriately.
@see wxScrolled::SetScrollbars() @see wxScrolled::SetScrollbars()
@deprecated @todo provide deprecation description
*/ */
void SetVirtualSizeHints(wxWindow* window); void SetVirtualSizeHints(wxWindow* window);
@@ -1569,22 +1571,22 @@ public:
/** /**
Returns the number of columns in the sizer. Returns the number of columns in the sizer.
*/ */
int GetCols(); int GetCols() const;
/** /**
Returns the horizontal gap (in pixels) between cells in the sizer. Returns the horizontal gap (in pixels) between cells in the sizer.
*/ */
int GetHGap(); int GetHGap() const;
/** /**
Returns the number of rows in the sizer. Returns the number of rows in the sizer.
*/ */
int GetRows(); int GetRows() const;
/** /**
Returns the vertical gap (in pixels) between the cells in the sizer. Returns the vertical gap (in pixels) between the cells in the sizer.
*/ */
int GetVGap(); int GetVGap() const;
/** /**
Sets the number of columns in the sizer. Sets the number of columns in the sizer.

40
interface/wx/slider.h
View File

@@ -90,21 +90,21 @@ public:
/** /**
Destructor, destroying the slider. Destructor, destroying the slider.
*/ */
~wxSlider(); virtual ~wxSlider();
/** /**
Clears the selection, for a slider with the @b wxSL_SELRANGE style. Clears the selection, for a slider with the @b wxSL_SELRANGE style.
@remarks Windows 95 only. @remarks Windows 95 only.
*/ */
void ClearSel(); virtual void ClearSel();
/** /**
Clears the ticks. Clears the ticks.
@remarks Windows 95 only. @remarks Windows 95 only.
*/ */
void ClearTicks(); virtual void ClearTicks();
/** /**
Used for two-step slider construction. See wxSlider() Used for two-step slider construction. See wxSlider()
@@ -123,28 +123,28 @@ public:
@see SetLineSize() @see SetLineSize()
*/ */
int GetLineSize() const; virtual int GetLineSize() const;
/** /**
Gets the maximum slider value. Gets the maximum slider value.
@see GetMin(), SetRange() @see GetMin(), SetRange()
*/ */
int GetMax() const; virtual int GetMax() const;
/** /**
Gets the minimum slider value. Gets the minimum slider value.
@see GetMin(), SetRange() @see GetMin(), SetRange()
*/ */
int GetMin() const; virtual int GetMin() const;
/** /**
Returns the page size. Returns the page size.
@see SetPageSize() @see SetPageSize()
*/ */
int GetPageSize() const; virtual int GetPageSize() const;
/** /**
Returns the selection end point. Returns the selection end point.
@@ -153,7 +153,7 @@ public:
@see GetSelStart(), SetSelection() @see GetSelStart(), SetSelection()
*/ */
int GetSelEnd() const; virtual int GetSelEnd() const;
/** /**
Returns the selection start point. Returns the selection start point.
@@ -162,7 +162,7 @@ public:
@see GetSelEnd(), SetSelection() @see GetSelEnd(), SetSelection()
*/ */
int GetSelStart() const; virtual int GetSelStart() const;
/** /**
Returns the thumb length. Returns the thumb length.
@@ -171,7 +171,7 @@ public:
@see SetThumbLength() @see SetThumbLength()
*/ */
int GetThumbLength() const; virtual int GetThumbLength() const;
/** /**
Returns the tick frequency. Returns the tick frequency.
@@ -180,14 +180,14 @@ public:
@see SetTickFreq() @see SetTickFreq()
*/ */
int GetTickFreq() const; virtual int GetTickFreq() const;
/** /**
Gets the current slider value. Gets the current slider value.
@see GetMin(), GetMax(), SetValue() @see GetMin(), GetMax(), SetValue()
*/ */
int GetValue() const; virtual int GetValue() const;
/** /**
Sets the line size for the slider. Sets the line size for the slider.
@@ -198,7 +198,7 @@ public:
@see GetLineSize() @see GetLineSize()
*/ */
void SetLineSize(int lineSize); virtual void SetLineSize(int lineSize);
/** /**
Sets the page size for the slider. Sets the page size for the slider.
@@ -208,14 +208,14 @@ public:
@see GetPageSize() @see GetPageSize()
*/ */
void SetPageSize(int pageSize); virtual void SetPageSize(int pageSize);
/** /**
Sets the minimum and maximum slider values. Sets the minimum and maximum slider values.
@see GetMin(), GetMax() @see GetMin(), GetMax()
*/ */
void SetRange(int minValue, int maxValue); virtual void SetRange(int minValue, int maxValue);
/** /**
Sets the selection. Sets the selection.
@@ -229,7 +229,7 @@ public:
@see GetSelStart(), GetSelEnd() @see GetSelStart(), GetSelEnd()
*/ */
void SetSelection(int startPos, int endPos); virtual void SetSelection(int startPos, int endPos);
/** /**
Sets the slider thumb length. Sets the slider thumb length.
@@ -241,7 +241,7 @@ public:
@see GetThumbLength() @see GetThumbLength()
*/ */
void SetThumbLength(int len); virtual void SetThumbLength(int len);
/** /**
Sets a tick position. Sets a tick position.
@@ -253,7 +253,7 @@ public:
@see SetTickFreq() @see SetTickFreq()
*/ */
void SetTick(int tickPos); virtual void SetTick(int tickPos);
/** /**
Sets the tick mark frequency and position. Sets the tick mark frequency and position.
@@ -269,7 +269,7 @@ public:
@see GetTickFreq() @see GetTickFreq()
*/ */
void SetTickFreq(int n, int pos); virtual void SetTickFreq(int n, int pos);
/** /**
Sets the slider position. Sets the slider position.
@@ -277,6 +277,6 @@ public:
@param value @param value
The slider position. The slider position.
*/ */
void SetValue(int value); virtual void SetValue(int value);
}; };

18
interface/wx/socket.h
View File

@@ -41,12 +41,12 @@ public:
/** /**
Returns the hostname which matches the IP address. Returns the hostname which matches the IP address.
*/ */
wxString Hostname(); virtual wxString Hostname() const;
/** /**
Returns a wxString containing the IP address in dot quad (127.0.0.1) format. Returns a wxString containing the IP address in dot quad (127.0.0.1) format.
*/ */
wxString IPAddress(); virtual wxString IPAddress() const;
/** /**
Set address to localhost (127.0.0.1). Set address to localhost (127.0.0.1).
@@ -108,7 +108,7 @@ public:
/** /**
Destructor (it doesn't close the accepted connections). Destructor (it doesn't close the accepted connections).
*/ */
~wxSocketServer(); virtual ~wxSocketServer();
/** /**
Accepts an incoming connection request, and creates a new wxSocketBase object Accepts an incoming connection request, and creates a new wxSocketBase object
@@ -283,7 +283,7 @@ public:
/** /**
Destructor. Please see wxSocketBase::Destroy(). Destructor. Please see wxSocketBase::Destroy().
*/ */
~wxSocketClient(); virtual ~wxSocketClient();
/** /**
Connects to a server using the specified address. Connects to a server using the specified address.
@@ -307,7 +307,7 @@ public:
@see WaitOnConnect(), wxSocketBase::SetNotify(), wxSocketBase::Notify() @see WaitOnConnect(), wxSocketBase::SetNotify(), wxSocketBase::Notify()
*/ */
bool Connect(const wxSockAddress& address, bool wait = true); virtual bool Connect(const wxSockAddress& address, bool wait = true);
/** /**
Connects to a server using the specified address. Connects to a server using the specified address.
@@ -397,12 +397,12 @@ public:
/** /**
Default destructor. Default destructor.
*/ */
~wxSockAddress(); virtual ~wxSockAddress();
/** /**
Delete all informations about the address. Delete all informations about the address.
*/ */
void Clear(); virtual void Clear();
/** /**
Returns the length of the socket address. Returns the length of the socket address.
@@ -439,7 +439,7 @@ public:
Gets the client data of the socket which generated this event, as Gets the client data of the socket which generated this event, as
set with wxSocketBase::SetClientData(). set with wxSocketBase::SetClientData().
*/ */
void* GetClientData(); void* GetClientData() const;
/** /**
Returns the socket object to which this event refers to. This makes Returns the socket object to which this event refers to. This makes
@@ -1215,7 +1215,7 @@ public:
/** /**
Destructor. Please see wxSocketBase::Destroy(). Destructor. Please see wxSocketBase::Destroy().
*/ */
~wxDatagramSocket(); virtual ~wxDatagramSocket();
/** /**
This function reads a buffer of @a nbytes bytes from the socket. This function reads a buffer of @a nbytes bytes from the socket.

2
interface/wx/sound.h
View File

@@ -39,7 +39,7 @@ public:
/** /**
Destroys the wxSound object. Destroys the wxSound object.
*/ */
~wxSound(); virtual ~wxSound();
/** /**
Constructs a wave object from a file or resource. Constructs a wave object from a file or resource.

12
interface/wx/spinbutt.h
View File

@@ -107,7 +107,7 @@ public:
/** /**
Destructor, destroys the spin button control. Destructor, destroys the spin button control.
*/ */
~wxSpinButton(); virtual ~wxSpinButton();
/** /**
Scrollbar creation function called by the spin button constructor. Scrollbar creation function called by the spin button constructor.
@@ -124,21 +124,21 @@ public:
@see SetRange() @see SetRange()
*/ */
int GetMax() const; virtual int GetMax() const;
/** /**
Returns the minimum permissible value. Returns the minimum permissible value.
@see SetRange() @see SetRange()
*/ */
int GetMin() const; virtual int GetMin() const;
/** /**
Returns the current spin button value. Returns the current spin button value.
@see SetValue() @see SetValue()
*/ */
int GetValue() const; virtual int GetValue() const;
/** /**
Sets the range of the spin button. Sets the range of the spin button.
@@ -150,7 +150,7 @@ public:
@see GetMin(), GetMax() @see GetMin(), GetMax()
*/ */
void SetRange(int min, int max); virtual void SetRange(int min, int max);
/** /**
Sets the value of the spin button. Sets the value of the spin button.
@@ -158,6 +158,6 @@ public:
@param value @param value
The value for the spin button. The value for the spin button.
*/ */
void SetValue(int value); virtual void SetValue(int value);
}; };

2
interface/wx/spinctrl.h
View File

@@ -118,7 +118,7 @@ public:
/** /**
Sets the value of the spin control. Use the variant using int instead. Sets the value of the spin control. Use the variant using int instead.
*/ */
void SetValue(const wxString& text); virtual void SetValue(const wxString& text);
/** /**
Sets the value of the spin control. Sets the value of the spin control.

2
interface/wx/splash.h
View File

@@ -58,7 +58,7 @@ public:
/** /**
Destroys the splash screen. Destroys the splash screen.
*/ */
~wxSplashScreen(); virtual ~wxSplashScreen();
/** /**
Returns the splash style (see wxSplashScreen() for Returns the splash style (see wxSplashScreen() for

6
interface/wx/splitter.h
View File

@@ -87,7 +87,7 @@ public:
/** /**
Destroys the wxSplitterWindow and its children. Destroys the wxSplitterWindow and its children.
*/ */
~wxSplitterWindow(); virtual ~wxSplitterWindow();
/** /**
Creation function, for two-step construction. See wxSplitterWindow() for Creation function, for two-step construction. See wxSplitterWindow() for
@@ -111,14 +111,14 @@ public:
@see SetSashGravity() @see SetSashGravity()
*/ */
double GetSashGravity(); double GetSashGravity() const;
/** /**
Returns the current sash position. Returns the current sash position.
@see SetSashPosition() @see SetSashPosition()
*/ */
int GetSashPosition(); int GetSashPosition() const;
/** /**
Gets the split mode. Gets the split mode.

4
interface/wx/srchctrl.h
View File

@@ -85,7 +85,7 @@ public:
/** /**
Destructor, destroying the search control. Destructor, destroying the search control.
*/ */
~wxSearchCtrl(); virtual ~wxSearchCtrl();
/** /**
Returns a pointer to the search control's menu object or @NULL if there is no Returns a pointer to the search control's menu object or @NULL if there is no
@@ -100,7 +100,7 @@ public:
button visibility value. button visibility value.
This always returns @false in Mac OS X v10.3 This always returns @false in Mac OS X v10.3
*/ */
virtual bool IsSearchButtonVisible(); virtual bool IsSearchButtonVisible() const;
/** /**
Sets the search control's menu object. If there is already a menu associated Sets the search control's menu object. If there is already a menu associated

8
interface/wx/stackwalk.h
View File

@@ -57,7 +57,7 @@ public:
Destructor does nothing neither but should be virtual as this class is used as Destructor does nothing neither but should be virtual as this class is used as
a base one. a base one.
*/ */
~wxStackWalker(); virtual ~wxStackWalker();
/** /**
This function must be overrided to process the given frame. This function must be overrided to process the given frame.
@@ -71,7 +71,7 @@ public:
notice that Walk() frame itself is not included if skip = 1). notice that Walk() frame itself is not included if skip = 1).
Up to @a maxDepth frames are walked from the innermost to the outermost one. Up to @a maxDepth frames are walked from the innermost to the outermost one.
*/ */
void Walk(size_t skip = 1, size_t maxDepth = 200); virtual void Walk(size_t skip = 1, size_t maxDepth = 200);
/** /**
Enumerate stack frames from the location of uncaught exception. Enumerate stack frames from the location of uncaught exception.
@@ -79,7 +79,7 @@ public:
wxApp::OnFatalException. wxApp::OnFatalException.
Up to @a maxDepth frames are walked from the innermost to the outermost one. Up to @a maxDepth frames are walked from the innermost to the outermost one.
*/ */
void WalkFromException(size_t maxDepth = 200); virtual void WalkFromException(size_t maxDepth = 200);
}; };
@@ -157,7 +157,7 @@ public:
can't retrieve the parameters info even although the function does have can't retrieve the parameters info even although the function does have
parameters). parameters).
*/ */
size_t GetParamCount() const; virtual size_t GetParamCount() const;
/** /**
Return @true if we have the file name and line number for this frame. Return @true if we have the file name and line number for this frame.

4
interface/wx/statbmp.h
View File

@@ -73,7 +73,7 @@ public:
@see SetBitmap() @see SetBitmap()
*/ */
wxBitmap GetBitmap() const; virtual wxBitmap GetBitmap() const;
/** /**
Returns the icon currently used in the control. Notice that this method can Returns the icon currently used in the control. Notice that this method can
@@ -83,7 +83,7 @@ public:
@see SetIcon() @see SetIcon()
*/ */
wxIcon GetIcon() const; virtual wxIcon GetIcon() const;
/** /**
Sets the bitmap label. Sets the bitmap label.

2
interface/wx/statbox.h
View File

@@ -68,7 +68,7 @@ public:
/** /**
Destructor, destroying the group box. Destructor, destroying the group box.
*/ */
~wxStaticBox(); virtual ~wxStaticBox();
/** /**
Creates the static box for two-step construction. See wxStaticBox() Creates the static box for two-step construction. See wxStaticBox()

2
interface/wx/statline.h
View File

@@ -78,7 +78,7 @@ public:
dimension of the static line, i.e. its height for a horizontal line or its dimension of the static line, i.e. its height for a horizontal line or its
width for a vertical one. width for a vertical one.
*/ */
int GetDefaultSize(); static int GetDefaultSize();
/** /**
Returns @true if the line is vertical, @false if horizontal. Returns @true if the line is vertical, @false if horizontal.

4
interface/wx/statusbr.h
View File

@@ -63,7 +63,7 @@ public:
/** /**
Destructor. Destructor.
*/ */
~wxStatusBar(); virtual ~wxStatusBar();
/** /**
Creates the window, for two-step construction. Creates the window, for two-step construction.
@@ -135,7 +135,7 @@ public:
bigger than the height specified here depending on the size of the font used by bigger than the height specified here depending on the size of the font used by
the status bar. the status bar.
*/ */
void SetMinHeight(int height); virtual void SetMinHeight(int height);
/** /**
Sets the styles of the fields in the status line which can make fields appear Sets the styles of the fields in the status line which can make fields appear

228
interface/wx/stc/stc.h
View File

@@ -324,7 +324,7 @@ public:
/** /**
Append a string to the end of the document without changing the selection. Append a string to the end of the document without changing the selection.
*/ */
void AppendText(const wxString& text); virtual void AppendText(const wxString& text);
/** /**
Append a string to the end of the document without changing the selection. Append a string to the end of the document without changing the selection.
@@ -350,18 +350,18 @@ public:
Retrieve whether or not autocompletion is hidden automatically when nothing Retrieve whether or not autocompletion is hidden automatically when nothing
matches. matches.
*/ */
bool AutoCompGetAutoHide(); bool AutoCompGetAutoHide() const;
/** /**
Retrieve whether auto-completion cancelled by backspacing before start. Retrieve whether auto-completion cancelled by backspacing before start.
*/ */
bool AutoCompGetCancelAtStart(); bool AutoCompGetCancelAtStart() const;
/** /**
Retrieve whether a single item auto-completion list automatically choose the Retrieve whether a single item auto-completion list automatically choose the
item. item.
*/ */
bool AutoCompGetChooseSingle(); bool AutoCompGetChooseSingle() const;
/** /**
Get currently selected item position in the auto-completion list Get currently selected item position in the auto-completion list
@@ -372,32 +372,32 @@ public:
Retrieve whether or not autocompletion deletes any word characters Retrieve whether or not autocompletion deletes any word characters
after the inserted text upon completion. after the inserted text upon completion.
*/ */
bool AutoCompGetDropRestOfWord(); bool AutoCompGetDropRestOfWord() const;
/** /**
Retrieve state of ignore case flag. Retrieve state of ignore case flag.
*/ */
bool AutoCompGetIgnoreCase(); bool AutoCompGetIgnoreCase() const;
/** /**
Set the maximum height, in rows, of auto-completion and user lists. Set the maximum height, in rows, of auto-completion and user lists.
*/ */
int AutoCompGetMaxHeight(); int AutoCompGetMaxHeight() const;
/** /**
Get the maximum width, in characters, of auto-completion and user lists. Get the maximum width, in characters, of auto-completion and user lists.
*/ */
int AutoCompGetMaxWidth(); int AutoCompGetMaxWidth() const;
/** /**
Retrieve the auto-completion list separator character. Retrieve the auto-completion list separator character.
*/ */
int AutoCompGetSeparator(); int AutoCompGetSeparator() const;
/** /**
Retrieve the auto-completion list type-separator character. Retrieve the auto-completion list type-separator character.
*/ */
int AutoCompGetTypeSeparator(); int AutoCompGetTypeSeparator() const;
/** /**
Retrieve the position of the caret when the auto-completion list was displayed. Retrieve the position of the caret when the auto-completion list was displayed.
@@ -558,12 +558,12 @@ public:
/** /**
Are there any redoable actions in the undo history? Are there any redoable actions in the undo history?
*/ */
bool CanRedo(); virtual bool CanRedo() const;
/** /**
Are there any undoable actions in the undo history? Are there any undoable actions in the undo history?
*/ */
bool CanUndo(); virtual bool CanUndo() const;
/** /**
Cancel any modes such as call tip or auto-completion list display. Cancel any modes such as call tip or auto-completion list display.
@@ -610,7 +610,7 @@ public:
/** /**
Clear the selection. Clear the selection.
*/ */
void Clear(); virtual void Clear();
/** /**
Delete all text in the document. Delete all text in the document.
@@ -660,7 +660,7 @@ public:
/** /**
Copy the selection to the clipboard. Copy the selection to the clipboard.
*/ */
void Copy(); virtual void Copy();
/** /**
Copy a range of text to the clipboard. Positions are clipped into the document. Copy a range of text to the clipboard. Positions are clipped into the document.
@@ -690,7 +690,7 @@ public:
/** /**
Cut the selection to the clipboard. Cut the selection to the clipboard.
*/ */
void Cut(); virtual void Cut();
/** /**
Delete back from the current position to the start of the line. Delete back from the current position to the start of the line.
@@ -819,73 +819,73 @@ public:
/** /**
Returns the position of the opposite end of the selection to the caret. Returns the position of the opposite end of the selection to the caret.
*/ */
int GetAnchor(); int GetAnchor() const;
/** /**
Does a backspace pressed when caret is within indentation unindent? Does a backspace pressed when caret is within indentation unindent?
*/ */
bool GetBackSpaceUnIndents(); bool GetBackSpaceUnIndents() const;
/** /**
Is drawing done first into a buffer or direct to the screen? Is drawing done first into a buffer or direct to the screen?
*/ */
bool GetBufferedDraw(); bool GetBufferedDraw() const;
/** /**
Get the foreground colour of the caret. Get the foreground colour of the caret.
*/ */
wxColour GetCaretForeground(); wxColour GetCaretForeground() const;
/** /**
Get the background alpha of the caret line. Get the background alpha of the caret line.
*/ */
int GetCaretLineBackAlpha(); int GetCaretLineBackAlpha() const;
/** /**
Get the colour of the background of the line containing the caret. Get the colour of the background of the line containing the caret.
*/ */
wxColour GetCaretLineBackground(); wxColour GetCaretLineBackground() const;
/** /**
Is the background of the line containing the caret in a different colour? Is the background of the line containing the caret in a different colour?
*/ */
bool GetCaretLineVisible(); bool GetCaretLineVisible() const;
/** /**
Get the time in milliseconds that the caret is on and off. Get the time in milliseconds that the caret is on and off.
*/ */
int GetCaretPeriod(); int GetCaretPeriod() const;
/** /**
Can the caret preferred x position only be changed by explicit movement Can the caret preferred x position only be changed by explicit movement
commands? commands?
*/ */
bool GetCaretSticky(); bool GetCaretSticky() const;
/** /**
Returns the width of the insert mode caret. Returns the width of the insert mode caret.
*/ */
int GetCaretWidth(); int GetCaretWidth() const;
/** /**
Returns the character byte at the position. Returns the character byte at the position.
*/ */
int GetCharAt(int pos); int GetCharAt(int pos) const;
/** /**
Get the code page used to interpret the bytes of the document as characters. Get the code page used to interpret the bytes of the document as characters.
*/ */
int GetCodePage(); int GetCodePage() const;
/** /**
Retrieve the column number of a position, taking tab width into account. Retrieve the column number of a position, taking tab width into account.
*/ */
int GetColumn(int pos); int GetColumn(int pos) const;
/** /**
Get the way control characters are displayed. Get the way control characters are displayed.
*/ */
int GetControlCharSymbol(); int GetControlCharSymbol() const;
/** /**
@@ -907,7 +907,7 @@ public:
/** /**
Returns the position of the caret. Returns the position of the caret.
*/ */
int GetCurrentPos(); int GetCurrentPos() const;
/** /**
Retrieve a pointer to the document object. Retrieve a pointer to the document object.
@@ -917,63 +917,63 @@ public:
/** /**
Retrieve the current end of line mode - one of CRLF, CR, or LF. Retrieve the current end of line mode - one of CRLF, CR, or LF.
*/ */
int GetEOLMode(); int GetEOLMode() const;
/** /**
Retrieve the colour used in edge indication. Retrieve the colour used in edge indication.
*/ */
wxColour GetEdgeColour(); wxColour GetEdgeColour() const;
/** /**
Retrieve the column number which text should be kept within. Retrieve the column number which text should be kept within.
*/ */
int GetEdgeColumn(); int GetEdgeColumn() const;
/** /**
Retrieve the edge highlight mode. Retrieve the edge highlight mode.
*/ */
int GetEdgeMode(); int GetEdgeMode() const;
/** /**
Retrieve whether the maximum scroll position has the last Retrieve whether the maximum scroll position has the last
line at the bottom of the view. line at the bottom of the view.
*/ */
bool GetEndAtLastLine(); bool GetEndAtLastLine() const;
/** /**
Retrieve the position of the last correctly styled character. Retrieve the position of the last correctly styled character.
*/ */
int GetEndStyled(); int GetEndStyled() const;
/** /**
Retrieve the display line at the top of the display. Retrieve the display line at the top of the display.
*/ */
int GetFirstVisibleLine(); int GetFirstVisibleLine() const;
/** /**
Is a header line expanded? Is a header line expanded?
*/ */
bool GetFoldExpanded(int line); bool GetFoldExpanded(int line) const;
/** /**
Retrieve the fold level of a line. Retrieve the fold level of a line.
*/ */
int GetFoldLevel(int line); int GetFoldLevel(int line) const;
/** /**
Find the parent line of a child line. Find the parent line of a child line.
*/ */
int GetFoldParent(int line); int GetFoldParent(int line) const;
/** /**
Get the highlighted indentation guide column. Get the highlighted indentation guide column.
*/ */
int GetHighlightGuide(); int GetHighlightGuide() const;
/** /**
Retrieve indentation size. Retrieve indentation size.
*/ */
int GetIndent(); int GetIndent() const;
/** /**
Are the indentation guides visible? Are the indentation guides visible?
@@ -983,7 +983,7 @@ public:
/** /**
Find the last child line of a header line. Find the last child line of a header line.
*/ */
int GetLastChild(int line, int level); int GetLastChild(int line, int level) const;
/** /**
Can be used to prevent the EVT_CHAR handler from adding the char Can be used to prevent the EVT_CHAR handler from adding the char
@@ -993,42 +993,42 @@ public:
/** /**
Retrieve the degree of caching of layout information. Retrieve the degree of caching of layout information.
*/ */
int GetLayoutCache(); int GetLayoutCache() const;
/** /**
Returns the number of characters in the document. Returns the number of characters in the document.
*/ */
int GetLength(); int GetLength() const;
/** /**
Retrieve the lexing language of the document. Retrieve the lexing language of the document.
*/ */
int GetLexer(); int GetLexer() const;
/** /**
Retrieve the contents of a line. Retrieve the contents of a line.
*/ */
wxString GetLine(int line); wxString GetLine(int line) const;
/** /**
Returns the number of lines in the document. There is always at least one. Returns the number of lines in the document. There is always at least one.
*/ */
int GetLineCount(); int GetLineCount() const;
/** /**
Get the position after the last visible characters on a line. Get the position after the last visible characters on a line.
*/ */
int GetLineEndPosition(int line); int GetLineEndPosition(int line) const;
/** /**
Retrieve the position before the first non indentation character on a line. Retrieve the position before the first non indentation character on a line.
*/ */
int GetLineIndentPosition(int line); int GetLineIndentPosition(int line) const;
/** /**
Retrieve the number of columns that a line is indented. Retrieve the number of columns that a line is indented.
*/ */
int GetLineIndentation(int line); int GetLineIndentation(int line) const;
/** /**
Retrieve the contents of a line. Retrieve the contents of a line.
@@ -1050,92 +1050,92 @@ public:
/** /**
Retrieve the extra styling information for a line. Retrieve the extra styling information for a line.
*/ */
int GetLineState(int line); int GetLineState(int line) const;
/** /**
Is a line visible? Is a line visible?
*/ */
bool GetLineVisible(int line); bool GetLineVisible(int line) const;
/** /**
Returns the size in pixels of the left margin. Returns the size in pixels of the left margin.
*/ */
int GetMarginLeft(); int GetMarginLeft() const;
/** /**
Retrieve the marker mask of a margin. Retrieve the marker mask of a margin.
*/ */
int GetMarginMask(int margin); int GetMarginMask(int margin) const;
/** /**
Returns the size in pixels of the right margin. Returns the size in pixels of the right margin.
*/ */
int GetMarginRight(); int GetMarginRight() const;
/** /**
Retrieve the mouse click sensitivity of a margin. Retrieve the mouse click sensitivity of a margin.
*/ */
bool GetMarginSensitive(int margin); bool GetMarginSensitive(int margin) const;
/** /**
Retrieve the type of a margin. Retrieve the type of a margin.
*/ */
int GetMarginType(int margin); int GetMarginType(int margin) const;
/** /**
Retrieve the width of a margin in pixels. Retrieve the width of a margin in pixels.
*/ */
int GetMarginWidth(int margin); int GetMarginWidth(int margin) const;
/** /**
Retrieve the last line number that has line state. Retrieve the last line number that has line state.
*/ */
int GetMaxLineState(); int GetMaxLineState() const;
/** /**
Get which document modification events are sent to the container. Get which document modification events are sent to the container.
*/ */
int GetModEventMask(); int GetModEventMask() const;
/** /**
Is the document different from when it was last saved? Is the document different from when it was last saved?
*/ */
bool GetModify(); bool GetModify() const;
/** /**
Get whether mouse gets captured. Get whether mouse gets captured.
*/ */
bool GetMouseDownCaptures(); bool GetMouseDownCaptures() const;
/** /**
Retrieve the time the mouse must sit still to generate a mouse dwell event. Retrieve the time the mouse must sit still to generate a mouse dwell event.
*/ */
int GetMouseDwellTime(); int GetMouseDwellTime() const;
/** /**
Returns @true if overtype mode is active otherwise @false is returned. Returns @true if overtype mode is active otherwise @false is returned.
*/ */
bool GetOvertype(); bool GetOvertype() const;
/** /**
Get convert-on-paste setting Get convert-on-paste setting
*/ */
bool GetPasteConvertEndings(); bool GetPasteConvertEndings() const;
/** /**
Returns the print colour mode. Returns the print colour mode.
*/ */
int GetPrintColourMode(); int GetPrintColourMode() const;
/** /**
Returns the print magnification. Returns the print magnification.
*/ */
int GetPrintMagnification(); int GetPrintMagnification() const;
/** /**
Is printing line wrapped? Is printing line wrapped?
*/ */
int GetPrintWrapMode(); int GetPrintWrapMode() const;
/** /**
Retrieve a 'property' value previously set with SetProperty. Retrieve a 'property' value previously set with SetProperty.
@@ -1152,37 +1152,37 @@ public:
Retrieve a 'property' value previously set with SetProperty, Retrieve a 'property' value previously set with SetProperty,
interpreted as an int AFTER any '$()' variable replacement. interpreted as an int AFTER any '$()' variable replacement.
*/ */
int GetPropertyInt(const wxString& key); int GetPropertyInt(const wxString& key) const;
/** /**
In read-only mode? In read-only mode?
*/ */
bool GetReadOnly(); bool GetReadOnly() const;
/** /**
Get cursor type. Get cursor type.
*/ */
int GetSTCCursor(); int GetSTCCursor() const;
/** /**
Get internal focus flag. Get internal focus flag.
*/ */
bool GetSTCFocus(); bool GetSTCFocus() const;
/** /**
Retrieve the document width assumed for scrolling. Retrieve the document width assumed for scrolling.
*/ */
int GetScrollWidth(); int GetScrollWidth() const;
/** /**
Get the search flags used by SearchInTarget. Get the search flags used by SearchInTarget.
*/ */
int GetSearchFlags(); int GetSearchFlags() const;
/** /**
Get the alpha of the selection. Get the alpha of the selection.
*/ */
int GetSelAlpha(); int GetSelAlpha() const;
/** /**
Retrieve the selected text. Retrieve the selected text.
@@ -1202,37 +1202,37 @@ public:
/** /**
Returns the position at the end of the selection. Returns the position at the end of the selection.
*/ */
int GetSelectionEnd(); int GetSelectionEnd() const;
/** /**
Get the mode of the current selection. Get the mode of the current selection.
*/ */
int GetSelectionMode(); int GetSelectionMode() const;
/** /**
Returns the position at the start of the selection. Returns the position at the start of the selection.
*/ */
int GetSelectionStart(); int GetSelectionStart() const;
/** /**
Get error status. Get error status.
*/ */
int GetStatus(); int GetStatus() const;
/** /**
Returns the style byte at the position. Returns the style byte at the position.
*/ */
int GetStyleAt(int pos); int GetStyleAt(int pos) const;
/** /**
Retrieve number of bits in style bytes used to hold the lexical state. Retrieve number of bits in style bytes used to hold the lexical state.
*/ */
int GetStyleBits(); int GetStyleBits() const;
/** /**
Retrieve the number of bits the current lexer needs for styling. Retrieve the number of bits the current lexer needs for styling.
*/ */
int GetStyleBitsNeeded(); int GetStyleBitsNeeded() const;
/** /**
Retrieve a buffer of cells. Retrieve a buffer of cells.
@@ -1242,32 +1242,32 @@ public:
/** /**
Does a tab pressed when caret is within indentation indent? Does a tab pressed when caret is within indentation indent?
*/ */
bool GetTabIndents(); bool GetTabIndents() const;
/** /**
Retrieve the visible size of a tab. Retrieve the visible size of a tab.
*/ */
int GetTabWidth(); int GetTabWidth() const;
/** /**
Get the position that ends the target. Get the position that ends the target.
*/ */
int GetTargetEnd(); int GetTargetEnd() const;
/** /**
Get the position that starts the target. Get the position that starts the target.
*/ */
int GetTargetStart(); int GetTargetStart() const;
/** /**
Retrieve all the text in the document. Retrieve all the text in the document.
*/ */
wxString GetText(); wxString GetText() const;
/** /**
Retrieve the number of characters in the document. Retrieve the number of characters in the document.
*/ */
int GetTextLength(); int GetTextLength() const;
/** /**
Retrieve a range of text. Retrieve a range of text.
@@ -1287,12 +1287,12 @@ public:
/** /**
Is drawing done in two phases with backgrounds drawn before foregrounds? Is drawing done in two phases with backgrounds drawn before foregrounds?
*/ */
bool GetTwoPhaseDraw(); bool GetTwoPhaseDraw() const;
/** /**
Is undo history being collected? Is undo history being collected?
*/ */
bool GetUndoCollection(); bool GetUndoCollection() const;
/** /**
Returns the current UseAntiAliasing setting. Returns the current UseAntiAliasing setting.
@@ -1302,58 +1302,58 @@ public:
/** /**
Is the horizontal scroll bar visible? Is the horizontal scroll bar visible?
*/ */
bool GetUseHorizontalScrollBar(); bool GetUseHorizontalScrollBar() const;
/** /**
Retrieve whether tabs will be used in indentation. Retrieve whether tabs will be used in indentation.
*/ */
bool GetUseTabs(); bool GetUseTabs() const;
/** /**
Is the vertical scroll bar visible? Is the vertical scroll bar visible?
*/ */
bool GetUseVerticalScrollBar(); bool GetUseVerticalScrollBar() const;
/** /**
Are the end of line characters visible? Are the end of line characters visible?
*/ */
bool GetViewEOL(); bool GetViewEOL() const;
/** /**
Are white space characters currently visible? Are white space characters currently visible?
Returns one of SCWS_* constants. Returns one of SCWS_* constants.
*/ */
int GetViewWhiteSpace(); int GetViewWhiteSpace() const;
/** /**
Retrieve whether text is word wrapped. Retrieve whether text is word wrapped.
*/ */
int GetWrapMode(); int GetWrapMode() const;
/** /**
Retrive the start indent for wrapped lines. Retrive the start indent for wrapped lines.
*/ */
int GetWrapStartIndent(); int GetWrapStartIndent() const;
/** /**
Retrive the display mode of visual flags for wrapped lines. Retrive the display mode of visual flags for wrapped lines.
*/ */
int GetWrapVisualFlags(); int GetWrapVisualFlags() const;
/** /**
Retrive the location of visual flags for wrapped lines. Retrive the location of visual flags for wrapped lines.
*/ */
int GetWrapVisualFlagsLocation(); int GetWrapVisualFlagsLocation() const;
/** /**
*/ */
int GetXOffset(); int GetXOffset() const;
/** /**
Retrieve the zoom level. Retrieve the zoom level.
*/ */
int GetZoom(); int GetZoom() const;
/** /**
Set caret to start of a line and ensure it is visible. Set caret to start of a line and ensure it is visible.
@@ -1420,12 +1420,12 @@ public:
/** /**
Retrieve the foreground colour of an indicator. Retrieve the foreground colour of an indicator.
*/ */
wxColour IndicatorGetForeground(int indic); wxColour IndicatorGetForeground(int indic) const;
/** /**
Retrieve the style of an indicator. Retrieve the style of an indicator.
*/ */
int IndicatorGetStyle(int indic); int IndicatorGetStyle(int indic) const;
/** /**
Set the foreground colour of an indicator. Set the foreground colour of an indicator.
@@ -1522,12 +1522,12 @@ public:
/** /**
Retrieve the line containing a position. Retrieve the line containing a position.
*/ */
int LineFromPosition(int pos); int LineFromPosition(int pos) const;
/** /**
How many characters are on a line, not including end of line characters? How many characters are on a line, not including end of line characters?
*/ */
int LineLength(int line); int LineLength(int line) const;
/** /**
Scroll horizontally and vertically. Scroll horizontally and vertically.
@@ -1572,7 +1572,7 @@ public:
/** /**
Retrieves the number of lines completely visible. Retrieves the number of lines completely visible.
*/ */
int LinesOnScreen(); int LinesOnScreen() const;
/** /**
Split the lines in the target into lines that are less wide than pixelWidth Split the lines in the target into lines that are less wide than pixelWidth
@@ -1727,7 +1727,7 @@ public:
/** /**
Paste the contents of the clipboard into the document replacing the selection. Paste the contents of the clipboard into the document replacing the selection.
*/ */
void Paste(); virtual void Paste();
/** /**
Retrieve the point in the window where a position is displayed. Retrieve the point in the window where a position is displayed.
@@ -1749,12 +1749,12 @@ public:
/** /**
Retrieve the position at the start of a line. Retrieve the position at the start of a line.
*/ */
int PositionFromLine(int line); int PositionFromLine(int line) const;
/** /**
Find the position from a point within the window. Find the position from a point within the window.
*/ */
int PositionFromPoint(wxPoint pt); int PositionFromPoint(wxPoint pt) const;
/** /**
Find the position from a point within the window but return Find the position from a point within the window but return
@@ -1765,7 +1765,7 @@ public:
/** /**
Redoes the next action on the undo history. Redoes the next action on the undo history.
*/ */
void Redo(); virtual void Redo();
/** /**
Register an image for use in autocompletion lists. Register an image for use in autocompletion lists.
@@ -1846,7 +1846,7 @@ public:
/** /**
Select all the text in the document. Select all the text in the document.
*/ */
void SelectAll(); virtual void SelectAll();
/** /**
Duplicate the selection. If selection empty duplicate the line containing the Duplicate the selection. If selection empty duplicate the line containing the
@@ -1858,7 +1858,7 @@ public:
Is the selection rectangular? The alternative is the more common stream Is the selection rectangular? The alternative is the more common stream
selection. selection.
*/ */
bool SelectionIsRectangle(); bool SelectionIsRectangle() const;
/** /**
Send a message to Scintilla Send a message to Scintilla
@@ -2601,7 +2601,7 @@ public:
/** /**
Undo one action in the undo history. Undo one action in the undo history.
*/ */
void Undo(); virtual void Undo();
/** /**
Transform the selection to upper case. Transform the selection to upper case.

22
interface/wx/stdpaths.h
View File

@@ -63,7 +63,7 @@ public:
@see wxFileConfig @see wxFileConfig
*/ */
wxString GetConfigDir() const; virtual wxString GetConfigDir() const;
/** /**
Return the location of the applications global, i.e. not user-specific, Return the location of the applications global, i.e. not user-specific,
@@ -75,7 +75,7 @@ public:
@see GetLocalDataDir() @see GetLocalDataDir()
*/ */
wxString GetDataDir() const; virtual wxString GetDataDir() const;
/** /**
Return the directory containing the current user's documents. Return the directory containing the current user's documents.
@@ -86,7 +86,7 @@ public:
@since 2.7.0 @since 2.7.0
*/ */
wxString GetDocumentsDir() const; virtual wxString GetDocumentsDir() const;
/** /**
Return the directory and the filename for the current executable. Return the directory and the filename for the current executable.
@@ -95,7 +95,7 @@ public:
- Windows: @c C:\\Programs\\AppFolder\\exename.exe - Windows: @c C:\\Programs\\AppFolder\\exename.exe
- Mac: @c /Programs/exename - Mac: @c /Programs/exename
*/ */
wxString GetExecutablePath() const; virtual wxString GetExecutablePath() const;
/** /**
@note This function is only available under Unix. @note This function is only available under Unix.
@@ -113,7 +113,7 @@ public:
This is the same as GetDataDir() except This is the same as GetDataDir() except
under Unix where it returns @c /etc/appname. under Unix where it returns @c /etc/appname.
*/ */
wxString GetLocalDataDir() const; virtual wxString GetLocalDataDir() const;
/** /**
Return the localized resources directory containing the resource files of the Return the localized resources directory containing the resource files of the
@@ -137,7 +137,7 @@ public:
@see wxDynamicLibrary @see wxDynamicLibrary
*/ */
wxString GetPluginsDir() const; virtual wxString GetPluginsDir() const;
/** /**
Return the directory where the application resource files are located. The Return the directory where the application resource files are located. The
@@ -154,7 +154,7 @@ public:
@see GetLocalizedResourcesDir() @see GetLocalizedResourcesDir()
*/ */
wxString GetResourcesDir() const; virtual wxString GetResourcesDir() const;
/** /**
Return the directory for storing temporary files. To create unique temporary Return the directory for storing temporary files. To create unique temporary
@@ -164,7 +164,7 @@ public:
@since 2.7.2 @since 2.7.2
*/ */
wxString GetTempDir() const; virtual wxString GetTempDir() const;
/** /**
Return the directory for the user config files: Return the directory for the user config files:
@@ -175,7 +175,7 @@ public:
directory, otherwise GetUserDataDir() is directory, otherwise GetUserDataDir() is
more appropriate. more appropriate.
*/ */
wxString GetUserConfigDir() const; virtual wxString GetUserConfigDir() const;
/** /**
Return the directory for the user-dependent application data files: Return the directory for the user-dependent application data files:
@@ -183,7 +183,7 @@ public:
- Windows: @c C:\\Documents @c and @c Settings\\username\\Application @c Data\\appname - Windows: @c C:\\Documents @c and @c Settings\\username\\Application @c Data\\appname
- Mac: @c ~/Library/Application @c Support/appname - Mac: @c ~/Library/Application @c Support/appname
*/ */
wxString GetUserDataDir() const; virtual wxString GetUserDataDir() const;
/** /**
Return the directory for user data files which shouldn't be shared with Return the directory for user data files which shouldn't be shared with
@@ -191,7 +191,7 @@ public:
This is the same as GetUserDataDir() for all platforms except Windows where it returns This is the same as GetUserDataDir() for all platforms except Windows where it returns
@c C:\\Documents @c and @c Settings\\username\\Local @c Settings\\Application @c Data\\appname @c C:\\Documents @c and @c Settings\\username\\Local @c Settings\\Application @c Data\\appname
*/ */
wxString GetUserLocalDataDir() const; virtual wxString GetUserLocalDataDir() const;
/** /**
@note This function is only available under Unix. @note This function is only available under Unix.

Some files were not shown because too many files have changed in this diff Show More