/**
Destructor.
*/
- ~wxDataObject();
+ virtual ~wxDataObject();
/**
Copy all supported formats in the given direction to the array pointed
Adds a file to the file list represented by this data object (Windows
only).
*/
- virtual void AddFile(const wxString& file);
+ void AddFile(const wxString& file);
/**
Returns the array of file names.
Returns a pointer to the wxDataViewColumn from which
the event was emitted or @NULL.
*/
- wxDataViewColumn* GetDataViewColumn();
+ wxDataViewColumn* GetDataViewColumn() const;
/**
Returns the wxDataViewModel associated with the event.
/**
Destructor.
*/
- ~wxDataViewIndexListModel();
+ virtual ~wxDataViewIndexListModel();
/**
Compare method that sorts the items by their index.
/**
Destructor.
*/
- ~wxDataViewCtrl();
+ virtual ~wxDataViewCtrl();
/**
Appends a wxDataViewColumn to the control. Returns @true on success.
/**
Collapses the item.
*/
- void Collapse(const wxDataViewItem& item);
+ virtual void Collapse(const wxDataViewItem& item);
/**
Create the control. Useful for two step creation.
/**
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 data model associated with the
control (if any).
*/
- virtual wxDataViewModel* GetModel() const;
+ wxDataViewModel* GetModel();
/**
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
their number.
*/
- int GetSelections(wxDataViewItemArray& sel) const;
+ virtual int GetSelections(wxDataViewItemArray& sel) const;
/**
Returns the wxDataViewColumn currently responsible for sorting
/**
Return @true if the item is selected.
*/
- bool IsSelected(const wxDataViewItem& item) const;
+ virtual bool IsSelected(const wxDataViewItem& item) const;
/**
Select the given item.
*/
- void Select(const wxDataViewItem& item);
+ virtual void Select(const wxDataViewItem& item);
/**
Select all items.
*/
- void SelectAll();
+ virtual void SelectAll();
/**
Set which column shall contain the tree-like expanders.
/**
Sets the selection to the array of wxDataViewItems.
*/
- void SetSelections(const wxDataViewItemArray& sel);
+ virtual void SetSelections(const wxDataViewItemArray& sel);
/**
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
selections are allowed.
*/
- void UnselectAll();
+ virtual void UnselectAll();
};
/**
Destructor.
*/
- ~wxDataViewModelNotifier();
+ virtual ~wxDataViewModelNotifier();
/**
Called by owning model.
/**
Called by owning model.
*/
- bool ItemsChanged(const wxDataViewItemArray& items);
+ virtual bool ItemsChanged(const wxDataViewItemArray& items);
/**
Called by owning model.
/**
Returns the cell mode.
*/
- virtual wxDataViewCellMode GetMode();
+ virtual wxDataViewCellMode GetMode() const;
/**
Returns pointer to the owning wxDataViewColumn.
*/
- virtual wxDataViewColumn* GetOwner() const;
+ wxDataViewColumn* GetOwner() const;
/**
This methods retrieves the value from the renderer in order to
Returns a string with the type of the wxVariant
supported by this renderer.
*/
- virtual wxString GetVariantType();
+ wxString GetVariantType() const;
/**
Sets the alignment of the renderer's content. The default value
Sets the owning wxDataViewColumn. This
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.
/**
Destructor.
*/
- ~wxDataViewCustomRenderer();
+ virtual ~wxDataViewCustomRenderer();
/**
Override this to react to double clicks or ENTER. This method will
/**
Destructor.
*/
- ~wxDataViewColumn();
+ virtual ~wxDataViewColumn();
/**
Returns the bitmap in the header of the column, if any.
Returns the index of the column of the model, which this
wxDataViewColumn is displaying.
*/
- unsigned int GetModelColumn();
+ unsigned int GetModelColumn() const;
/**
Returns the owning wxDataViewCtrl.
Returns the renderer of this wxDataViewColumn.
See also wxDataViewRenderer.
*/
- wxDataViewRenderer* GetRenderer();
+ wxDataViewRenderer* GetRenderer() const;
/**
Returns @true if the column is reorderable.
/**
Returns the width of the column.
*/
- int GetWidth();
+ virtual int GetWidth() const;
/**
Returns @true, if the sort order is ascending.
See also SetSortOrder()
*/
- bool IsSortOrderAscending();
+ virtual bool IsSortOrderAscending() const;
/**
Set the alignment of the column header.
*/
- void SetAlignment(wxAlignment align);
+ virtual void SetAlignment(wxAlignment align);
/**
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
user using the mouse. This is typically implemented
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
wxDataViewCtrl supports it, most commonly by showing
a little arrow.
*/
- void SetSortOrder(bool ascending);
+ virtual void SetSortOrder(bool ascending);
/**
Indicate that the column is sortable. This does
no longer clickable and the sort indicator (little
arrow) will disappear.
*/
- void SetSortable(bool sortable);
+ virtual void SetSortable(bool sortable);
/**
Set the title of the column header to @e title.
*/
- void SetTitle(const wxString& title);
+ virtual void SetTitle(const wxString& title);
};
/**
Destructor. Deletes the image list if any.
*/
- ~wxDataViewTreeCtrl();
+ virtual ~wxDataViewTreeCtrl();
/**
/**
Destructor.
*/
- ~wxDataViewTreeStore();
+ virtual ~wxDataViewTreeStore();
/**
Append a container.
Convert device X coordinate to logical coordinate, using the current
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
current mapping mode and user scale factor but ignoring the
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
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
current mapping mode and user scale factor but ignoring the
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
/**
Gets the character height of the currently set font.
*/
- wxCoord GetCharHeight();
+ wxCoord GetCharHeight() const;
/**
Gets the average character width of the currently set font.
*/
- wxCoord GetCharWidth();
+ wxCoord GetCharWidth() const;
/**
Gets the rectangle surrounding the current clipping region.
@see SetLogicalFunction()
*/
- int GetLogicalFunction();
+ int GetLogicalFunction() const;
/**
Gets the mapping mode for the device context.
@see SetMapMode()
*/
- int GetMapMode();
+ int GetMapMode() const;
/**
Gets the dimensions of the string using the currently selected font.
The wxColour value is returned and is not required as a parameter.
@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.
Converts logical X coordinate to device coordinate, using the current
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
current mapping mode and user scale factor but ignoring the
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
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
current mapping mode and user scale factor but ignoring the
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.
*/
- wxCoord MaxX();
+ wxCoord MaxX() const;
/**
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.
*/
- wxCoord MinX();
+ wxCoord MinX() const;
/**
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
This function destroys the temporary window created to implement on-top
drawing (X only).
*/
- bool EndDrawingOnTop();
+ static bool EndDrawingOnTop();
/**
Use this in conjunction with EndDrawingOnTop() to ensure that drawing
that this function allows the screen to be refreshed
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
to the screen occurs on top of existing windows. Without this, some
that this function allows the screen to be refreshed
afterwards, may be useful to some applications.
*/
- bool StartDrawingOnTop(wxRect* rect = NULL);
+ static bool StartDrawingOnTop(wxRect* rect = NULL);
};
/**
Destructor.
*/
- ~wxSVGFileDC();
+ virtual ~wxSVGFileDC();
/**
Copies from a source DC to this DC, specifying the destination
constructor with all the files it contains. Call Reset() to prevent
this from happening.
*/
- ~wxDebugReport();
+ virtual ~wxDebugReport();
/**
Adds all available information to the report. Currently this includes a
Add an XML file containing the current or exception context and the
stack trace.
*/
- bool AddContext(Context ctx);
+ virtual bool AddContext(Context ctx);
/**
The same as calling AddContext(Context_Current).
@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
Gets the name used as a base name for various files, by default
wxApp::GetAppName() is used.
*/
- wxString GetReportName() const;
+ virtual wxString GetReportName() const;
/**
Returns @true if the object was successfully initialized. If this
Destructor. Deletes any child windows before deleting the physical
window.
*/
- ~wxDialog();
+ virtual ~wxDialog();
/**
Adds an identifier to be regarded as a main button for the
@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
@ref overview_dialog "layout adaptation code" to know that only the
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.
@see @ref overview_dialog_autoscrolling (for more on layout adaptation)
*/
- int GetLayoutAdaptationLevel();
+ int GetLayoutAdaptationLevel() const;
/**
Gets the adaptation mode, overriding the global adaptation flag.
@see SetReturnCode(), ShowModal(), EndModal()
*/
- int GetReturnCode();
+ int GetReturnCode() const;
/**
On PocketPC, a dialog is automatically provided with an empty toolbar.
/**
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.
@see EndModal(), GetReturnCode(), SetReturnCode()
*/
- int ShowModal();
+ virtual int ShowModal();
};
/**
Destructor.
*/
- ~wxDialUpManager();
+ virtual ~wxDialUpManager();
/**
Cancel dialing the number initiated with Dial() with async parameter
platform-specific class derived from wxDialUpManager. You should delete
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.
*/
size_t Traverse(wxDirTraverser& sink,
const wxString& filespec = wxEmptyString,
- int flags = wxDIR_DEFAULT);
+ int flags = wxDIR_DEFAULT) const;
};
/**
Destructor.
*/
- ~wxGenericDirCtrl();
+ virtual ~wxGenericDirCtrl();
/**
Collapse the given @a path.
*/
- bool CollapsePath(const wxString& path);
+ virtual bool CollapsePath(const wxString& path);
/**
Collapses the entire tree.
*/
- void CollapseTree();
+ virtual void CollapseTree();
/**
Create function for two-step construction. See wxGenericDirCtrl() for
Tries to expand as much of the given @a path as possible, so that the
filename or directory is visible in the tree control.
*/
- bool ExpandPath(const wxString& path);
+ virtual bool ExpandPath(const wxString& path);
/**
Gets the default path.
*/
- wxString GetDefaultPath() const;
+ virtual wxString GetDefaultPath() const;
/**
Gets selected filename path only (else empty string).
This function doesn't count a directory as a selection.
*/
- wxString GetFilePath() const;
+ virtual wxString GetFilePath() const;
/**
Returns the filter string.
*/
- wxString GetFilter() const;
+ virtual wxString GetFilter() const;
/**
Returns the current filter index (zero-based).
*/
- int GetFilterIndex() const;
+ virtual int GetFilterIndex() const;
/**
Returns a pointer to the filter list control (if present).
*/
- wxDirFilterListCtrl* GetFilterListCtrl() const;
+ virtual wxDirFilterListCtrl* GetFilterListCtrl() const;
/**
Gets the currently-selected directory or filename.
*/
- wxString GetPath() const;
+ virtual wxString GetPath() const;
/**
Returns the root id for the tree control.
*/
- wxTreeItemId GetRootId();
+ virtual wxTreeItemId GetRootId();
/**
Returns a pointer to the tree control.
*/
- wxTreeCtrl* GetTreeCtrl() const;
+ virtual wxTreeCtrl* GetTreeCtrl() const;
/**
Initializes variables.
*/
- void Init();
+ virtual void Init();
/**
Collapse and expand the tree, thus re-creating it from scratch. May be
used to update the displayed directory content.
*/
- void ReCreateTree();
+ virtual void ReCreateTree();
/**
Sets the default path.
*/
- void SetDefaultPath(const wxString& path);
+ virtual void SetDefaultPath(const wxString& path);
/**
Sets the filter string.
*/
- void SetFilter(const wxString& filter);
+ virtual void SetFilter(const wxString& filter);
/**
Sets the current filter index (zero-based).
*/
- void SetFilterIndex(int n);
+ virtual void SetFilterIndex(int n);
/**
Sets the current path.
*/
- void SetPath(const wxString& path);
+ virtual void SetPath(const wxString& path);
/**
@param show
If @true, hidden folders and files will be displayed by the
control. If @false, they will not be displayed.
*/
- void ShowHidden(bool show);
+ virtual void ShowHidden(bool show);
};
/**
Destructor.
*/
- ~wxDirDialog();
+ virtual ~wxDirDialog();
/**
Returns the message that will be displayed on the dialog.
*/
- wxString GetMessage() const;
+ virtual wxString GetMessage() const;
/**
Returns the default or user-selected path.
*/
- wxString GetPath() const;
+ virtual wxString GetPath() const;
/**
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.
*/
- void SetPath(const wxString& path);
+ virtual void SetPath(const wxString& path);
/**
Shows the dialog, returning wxID_OK if the user pressed OK, and
Returns @true if the display is the primary display. The primary
display is the one whose index is 0.
*/
- bool IsPrimary();
+ bool IsPrimary() const;
};
/**
Destructor. Deletes the associated data object, if any.
*/
- ~wxDropTarget();
+ virtual ~wxDropTarget();
/**
This method may only be called from within OnData(). By default, this
/**
Default constructor.
*/
- ~wxDropSource();
+ virtual ~wxDropSource();
/**
Starts the drag-and-drop operation which will terminate when the user
/**
Destructor.
*/
- ~wxDocMDIParentFrame();
+ virtual ~wxDocMDIParentFrame();
/**
Creates the window.
/**
Destructor.
*/
- ~wxDocMDIChildFrame();
+ virtual ~wxDocMDIChildFrame();
/**
Returns the document associated with this frame.
/**
Destructor.
*/
- ~wxDocTemplate();
+ virtual ~wxDocTemplate();
/**
Creates a new instance of the associated document class. If you have
This function calls InitDocument() which in turns calls
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
supplied a wxClassInfo parameter to the template constructor, you will
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
the document template constructor.
*/
- wxString GetDefaultExtension();
+ wxString GetDefaultExtension() const;
/**
Returns the text description of this template, as passed to the
document template constructor.
*/
- wxString GetDescription();
+ wxString GetDescription() const;
/**
Returns the default directory, as passed to the document template
constructor.
*/
- wxString GetDirectory();
+ wxString GetDirectory() const;
/**
Returns a pointer to the document manager instance for which this
template was created.
*/
- wxDocManager* GetDocumentManager();
+ wxDocManager* GetDocumentManager() const;
/**
Returns the document type name, as passed to the document template
constructor.
*/
- wxString GetDocumentName();
+ virtual wxString GetDocumentName() const;
/**
Returns the file filter, as passed to the document template
constructor.
*/
- wxString GetFileFilter();
+ wxString GetFileFilter() const;
/**
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
constructor.
*/
- wxString GetViewName();
+ virtual wxString GetViewName() const;
/**
Initialises the document, calling wxDocument::OnCreate(). This is
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,
@false otherwise.
*/
- bool IsVisible();
+ bool IsVisible() const;
/**
Sets the default file extension.
/**
Destructor.
*/
- ~wxDocManager();
+ virtual ~wxDocManager();
/**
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 a file to the file history list, if we have a pointer to an
appropriate file menu.
*/
- void AddFileToHistory(const wxString& filename);
+ virtual void AddFileToHistory(const wxString& filename);
/**
Adds the template to the document manager's template list.
file path and type.
@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
Appends the files in the history list to all menus managed by the file
history object.
*/
- void FileHistoryAddFilesToMenu();
+ virtual void FileHistoryAddFilesToMenu();
/**
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.
@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
history object.
*/
- void FileHistoryRemoveMenu(wxMenu* menu);
+ virtual void FileHistoryRemoveMenu(wxMenu* menu);
/**
Saves the file history into a config object. This must be called
@see wxConfigBase
*/
- void FileHistorySave(wxConfigBase& resourceFile);
+ virtual void FileHistorySave(wxConfigBase& resourceFile);
/**
Use this menu for appending recently-visited document filenames, for
@note You can add multiple menus using this function, to be managed by
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
only an approximate method of finding a template for creating a
document.
*/
- wxDocTemplate* FindTemplateForPath(const wxString& path);
+ virtual wxDocTemplate* FindTemplateForPath(const wxString& path);
/**
Returns the document associated with the currently active view (if
any).
*/
- wxDocument* GetCurrentDocument();
+ wxDocument* GetCurrentDocument() const;
/**
Returns the currently active view
*/
- wxView* GetCurrentView();
+ virtual wxView* GetCurrentView() const;
/**
Returns a reference to the list of documents.
/**
Returns a pointer to file history.
*/
- wxFileHistory* GetFileHistory();
+ virtual wxFileHistory* GetFileHistory() const;
/**
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 number of documents that can be open simultaneously.
*/
- int GetMaxDocsOpen();
+ int GetMaxDocsOpen() const;
/**
Returns a reference to the list of associated templates.
The bottom line: if you're not deriving from Initialize(), forget it
and construct wxDocManager with no arguments.
*/
- bool Initialize();
+ virtual bool Initialize();
/**
Return a string containing a suitable default name for a new document.
string @b unnamed but can be overridden in the derived classes to do
something more appropriate.
*/
- wxString MakeNewDocumentName();
+ virtual wxString MakeNewDocumentName();
/**
A hook to allow a derived class to create a different type of file
history. Called from Initialize().
*/
- wxFileHistory* OnCreateFileHistory();
+ virtual wxFileHistory* OnCreateFileHistory();
/**
Closes and deletes the currently active document.
/**
Destructor. Removes itself from the document's list of views.
*/
- ~wxView();
+ virtual ~wxView();
/**
Call this from your view frame's wxDocChildFrame::OnActivate() member
uses notebook pages instead of frames and this is why this method
returns a wxWindow and not a wxFrame.
*/
- wxWindow* GetFrame();
+ wxWindow* GetFrame() const;
/**
Gets the name associated with the view (passed to the wxDocTemplate
Associates the given document with the view. Normally called by the
framework.
*/
- void SetDocument(wxDocument* doc);
+ virtual void SetDocument(wxDocument* doc);
/**
Sets the frame associated with this view. The application should call
/**
Destructor.
*/
- ~wxDocChildFrame();
+ virtual ~wxDocChildFrame();
/**
Returns the document associated with this frame.
/**
Destructor.
*/
- ~wxDocParentFrame();
+ virtual ~wxDocParentFrame();
/**
Used in two-step construction.
/**
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
@see wxCommandProcessor
*/
- wxCommandProcessor* GetCommandProcessor() const;
+ virtual wxCommandProcessor* GetCommandProcessor() const;
/**
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 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
document-related dialog boxes. By default, uses the frame associated
with the first view.
*/
- wxWindow* GetDocumentWindow() const;
+ virtual wxWindow* GetDocumentWindow() const;
/**
Gets the filename associated with this document, or "" if none is
Sets the pointer to the template that created the document. Should only
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.
view. @a hint represents optional information to allow a view to
optimize its update.
*/
- void UpdateAllViews(wxView* sender = NULL, wxObject* hint = NULL);
+ virtual void UpdateAllViews(wxView* sender = NULL, wxObject* hint = NULL);
protected:
/**
/**
Destructor.
*/
- ~wxFileHistory();
+ virtual ~wxFileHistory();
/**
Adds a file to the file history list, if the object has a pointer to an
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
history object.
*/
- void AddFilesToMenu();
+ virtual void AddFilesToMenu();
/**
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 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).
*/
- wxString GetHistoryFile(size_t index) const;
+ virtual wxString GetHistoryFile(size_t index) const;
/**
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.
@see wxConfigBase
*/
- void Load(const wxConfigBase& config);
+ virtual void Load(const wxConfigBase& config);
/**
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.
*/
- void RemoveMenu(wxMenu* menu);
+ virtual void RemoveMenu(wxMenu* menu);
/**
Saves the file history into the given config object. This must be
@see wxConfigBase
*/
- void Save(wxConfigBase& config);
+ virtual void Save(wxConfigBase& config);
/**
Sets the base identifier for the range used for appending items.
with filenames that are already in the history when this function is
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
applications to draw their own image instead of using an actual bitmap.
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.
This function is available in wxGenericDragImage only.
*/
- bool UpdateBackingFromWindow(wxDC& windowDC, wxMemoryDC& destDC,
- const wxRect& sourceRect,
- const wxRect& destRect) const;
+ virtual bool UpdateBackingFromWindow(wxDC& windowDC, wxMemoryDC& destDC,
+ const wxRect& sourceRect,
+ const wxRect& destRect) const;
};
/**
Destructor, destroying the list box.
*/
- ~wxEditableListBox();
+ virtual ~wxEditableListBox();
/**
Creates the editable listbox for two-step construction.
/**
Destructor.
*/
- ~wxFindReplaceDialog();
+ virtual ~wxFindReplaceDialog();
/**
Creates the dialog; use wxWindow::Show to show it on screen.
/**
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.
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.
@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.
*/
- int GetFilterIndex() const;
+ virtual int GetFilterIndex() const;
/**
Returns the full path (directory and filename) of the currently selected file.
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.
@remarks paths is emptied first.
*/
- void GetPaths(wxArrayString& paths) const;
+ virtual void GetPaths(wxArrayString& paths) const;
/**
Returns the current wildcard.
*/
- wxString GetWildcard() const;
+ virtual wxString GetWildcard() const;
/**
Sets(changes) the current directory displayed in the control.
@return Returns @true on success, @false otherwise.
*/
- bool SetDirectory(const wxString& directory);
+ virtual bool SetDirectory(const wxString& directory);
/**
Selects a certain file.
@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.
*/
- void SetFilterIndex(int filterIndex);
+ virtual void SetFilterIndex(int filterIndex);
/**
Sets the wildcard, which can contain multiple file types, for example:
"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.
/**
Destructor.
*/
- ~wxFileDialog();
+ virtual ~wxFileDialog();
/**
Returns the default directory.
*/
- wxString GetDirectory() const;
+ virtual wxString GetDirectory() const;
/**
If functions SetExtraControlCreator() and ShowModal() were called,
/**
Returns the default filename.
*/
- wxString GetFilename() const;
+ virtual wxString GetFilename() const;
/**
Fills the array @a filenames with the names of the files chosen.
of each referenced file by appending the directory containing the shortcuts
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
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.
*/
- wxString GetMessage() const;
+ virtual wxString GetMessage() const;
/**
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.
This function should only be used with the dialogs which have @c wxFD_MULTIPLE style,
use GetPath() for the others.
*/
- void GetPaths(wxArrayString& paths) const;
+ virtual void GetPaths(wxArrayString& paths) const;
/**
Returns the file dialog wildcard.
*/
- wxString GetWildcard() const;
+ virtual wxString GetWildcard() const;
/**
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
/**
Sets the default filename.
*/
- void SetFilename(const wxString& setfilename);
+ virtual void SetFilename(const wxString& setfilename);
/**
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.
*/
- void SetMessage(const wxString& message);
+ virtual void SetMessage(const wxString& message);
/**
Sets the path (the combined directory and filename that will be returned when
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:
Note that the native Motif dialog has some limitations with respect to
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
otherwise.
*/
- int ShowModal();
+ virtual int ShowModal();
};
not be read (because e.g. the file is locked by another process) the returned
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 actual path (set by wxFileSystem::ChangePathTo).
*/
- wxString GetPath();
+ wxString GetPath() const;
/**
This static function returns @true if there is a registered handler which can
GetMimeTypeFromExt("index.htm") == "text/html"
@endcode
*/
- wxString GetMimeTypeFromExt(const wxString& location);
+ static wxString GetMimeTypeFromExt(const wxString& location);
/**
Returns the protocol string extracted from @a location.
pointer to the font object is stored in an application
data structure, and there is a risk of double deletion.
*/
- ~wxFont();
+ virtual ~wxFont();
/**
Returns the current application's default encoding.
@see SetFaceName()
*/
- wxString GetFaceName() const;
+ virtual wxString GetFaceName() const;
/**
Gets the font family. See SetFamily() for a list of valid
@see GetNativeFontInfoDesc()
*/
- wxString GetNativeFontInfoUserDesc();
+ wxString GetNativeFontInfoUserDesc() const;
/**
Gets the point size.
@see SetPointSize()
*/
- int GetPointSize() const;
+ virtual int GetPointSize() const;
/**
Gets the font style. See wxFontStyle for a list of valid styles.
@see SetUnderlined()
*/
- bool GetUnderlined() const;
+ virtual bool GetUnderlined() const;
/**
Gets the font weight. See wxFontWeight for a list of valid weight identifiers.
Returns @true if the font is a fixed width (or monospaced) font,
@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.
@see GetFaceName(), SetFamily()
*/
- bool SetFaceName(const wxString& faceName);
+ virtual bool SetFaceName(const wxString& faceName);
/**
Sets the font family.
@see GetPointSize()
*/
- void SetPointSize(int pointSize);
+ virtual void SetPointSize(int pointSize);
/**
Sets the font style.
/**
Destructor. Destroys all child windows and menu bar if present.
*/
- ~wxFrame();
+ virtual ~wxFrame();
/**
Centres the frame on the display.
Returns the origin of the frame client area (in client coordinates).
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).
@see SetMenuBar(), wxMenuBar, wxMenu
*/
- wxMenuBar* GetMenuBar() const;
+ virtual wxMenuBar* GetMenuBar() const;
/**
Returns a pointer to the status bar currently associated with the frame
@see CreateStatusBar(), wxStatusBar
*/
- wxStatusBar* GetStatusBar() const;
+ virtual wxStatusBar* GetStatusBar() const;
/**
Returns the status bar pane used to display menu and toolbar help.
@see SetStatusBarPane()
*/
- int GetStatusBarPane();
+ int GetStatusBarPane() const;
/**
Returns a pointer to the toolbar currently associated with the frame (if any).
@see CreateToolBar(), wxToolBar, SetToolBar()
*/
- wxToolBar* GetToolBar() const;
+ virtual wxToolBar* GetToolBar() const;
/**
Virtual function called when a status bar is requested by CreateStatusBar().
@see GetMenuBar(), wxMenuBar, wxMenu.
*/
- void SetMenuBar(wxMenuBar* menuBar);
+ virtual void SetMenuBar(wxMenuBar* menuBar);
/**
Associates a status bar with the frame.
@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.
/**
Associates a toolbar with the frame.
*/
- void SetToolBar(wxToolBar* toolBar);
+ virtual void SetToolBar(wxToolBar* toolBar);
};
/**
Destructor, destroying the gauge.
*/
- ~wxGauge();
+ virtual ~wxGauge();
/**
Creates the gauge for two-step construction. See wxGauge() for further
undefined and thus you need to explicitely call SetValue() if you
want to restore the determinate mode.
*/
- void Pulse();
+ virtual void Pulse();
/**
Sets the 3D bezel face width.
is, wxColour::IsOk() will return @false) if the colour wasn't found in
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
/**
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.
/**
Parameters string format is "width[,precision]".
*/
- void SetParameters(const wxString& params);
+ virtual void SetParameters(const wxString& params);
/**
Sets the precision.
/**
Final cleanup.
*/
- void Destroy();
+ virtual void Destroy();
/**
Complete the editing of the current cell. Returns @true if the value has
Some types of controls on some platforms may need some help
with the Return key.
*/
- void HandleReturn(wxKeyEvent& event);
+ virtual void HandleReturn(wxKeyEvent& event);
/**
/**
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
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
called.
*/
- void StartingClick();
+ virtual void StartingClick();
/**
If the editor is enabled by pressing keys on the grid,
this will be called to let the editor do something about
that first key if desired.
*/
- void StartingKey(wxKeyEvent& event);
+ virtual void StartingKey(wxKeyEvent& event);
};
The parameters string format is "n" where n is a number representing the
maximum width.
*/
- void SetParameters(const wxString& params);
+ virtual void SetParameters(const wxString& params);
};
/**
Parameters string format is "item1[,item2[...,itemN]]"
*/
- void SetParameters(const wxString& params);
+ virtual void SetParameters(const wxString& params);
};
/**
Parameters string format is "min,max".
*/
- void SetParameters(const wxString& params);
+ virtual void SetParameters(const wxString& params);
};
/**
Column at which the event occurred.
*/
- int GetCol();
+ virtual int GetCol();
/**
Position in pixels 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.
/**
Parameters string format is "width,precision"
*/
- void SetParameters(const wxString& params);
+ virtual void SetParameters(const wxString& params);
};
without (yet) matching calls to EndBatch(). While
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
See GetRowGridLinePen() for an example.
*/
- wxPen GetColGridLinePen(int col);
+ virtual wxPen GetColGridLinePen(int col);
/**
Sets the arguments to the current column label alignment values.
@see GetColGridLinePen(), GetRowGridLinePen()
*/
- wxPen GetDefaultGridLinePen();
+ virtual wxPen GetDefaultGridLinePen();
/**
Returns a pointer to the current default grid cell renderer.
}
@endcode
*/
- wxPen GetRowGridLinePen(int row);
+ virtual wxPen GetRowGridLinePen(int row);
/**
Returns the alignment used for row labels.
/**
Destroys the hash table.
*/
- ~wxHashTable();
+ virtual ~wxHashTable();
/**
The counterpart of @e Next. If the application wishes to iterate
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).
*/
- long MakeKey(const wxString& string);
+ static long MakeKey(const wxString& string);
/**
If the application wishes to iterate through all the data in the hash
@param param
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).
finding particular cell in the list, try Find() method
instead.
*/
- wxHtmlCell* GetFirstChild();
+ virtual wxHtmlCell* GetFirstChild() const;
/**
Returns height of the cell (m_Height member).
@param 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
/**
Sets the cell's position within parent container.
*/
- void SetPos(int x, int y);
+ virtual void SetPos(int x, int y);
};
only within wxHtmlWindow::OnLinkClicked,
@NULL otherwise.
*/
- const wxMouseEvent* GetEvent();
+ const wxMouseEvent* GetEvent() const;
/**
Return @e HREF value of the @c A tag.
*/
- wxString GetHref();
+ wxString GetHref() const;
/**
Return pointer to the cell that was clicked. Valid
only within wxHtmlWindow::OnLinkClicked,
@NULL otherwise.
*/
- const wxHtmlCell* GetHtmlCell();
+ const wxHtmlCell* GetHtmlCell() const;
/**
Return @e TARGET value of the @c A tag (this value
is used to specify in which frame should be the page pointed
by @ref gethref() Href opened).
*/
- wxString GetTarget();
+ wxString GetTarget() const;
};
Parse() or any function called
by it (i.e. from tag handlers).
*/
- void StopParsing();
+ virtual void StopParsing();
};
Returns beginning position of the text @e between this tag and paired
ending tag.
See explanation (returned position is marked with '|'):
+ @deprecated @todo provide deprecation description
*/
int GetBeginPos() const;
If no page is opened or if the displayed page wasn't
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
displayed page wasn't
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
contain @c TITLE tag.
*/
- wxString GetOpenedPageTitle();
+ wxString GetOpenedPageTitle() const;
/**
Returns the related frame.
@see LoadPage()
*/
- virtual bool LoadFile(const wxFileName& filename);
+ bool LoadFile(const wxFileName& filename);
/**
Unlike SetPage this function first loads HTML page from @a location
URL if OnOpeningURL returns wxHTML_REDIRECT.
*/
virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type,
- const wxString& url,
- wxString* redirect);
+ const wxString& url,
+ wxString* redirect) const;
/**
Called on parsing @c TITLE tag.
@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
/**
Destructor cleans up whatever resources we use.
*/
- ~wxHtmlListBox();
+ virtual ~wxHtmlListBox();
/**
Creates the control and optionally sets the initial number of items in it
/**
Frees the array of stored items and relative client data.
*/
- ~wxSimpleHtmlListBox();
+ virtual ~wxSimpleHtmlListBox();
//@{
/**
Returns the colour used to print the label of the hyperlink when the mouse is
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
before
(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.
*/
- wxString GetURL() const;
+ virtual wxString GetURL() const;
/**
Returns @true if the hyperlink has already been clicked by the user at least
and the link has already been clicked before (i.e. the link has been @e
visited).
*/
- wxColour GetVisitedColour() const;
+ virtual wxColour GetVisitedColour() const;
/**
Sets the colour used to print the label of the hyperlink when the mouse is over
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
before
(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.
*/
- void SetURL(const wxString& url);
+ virtual void SetURL(const wxString& url);
/**
Marks the hyperlink as visited (see wxHyperlinkCtrl::SetVisitedColour).
and the link has already been clicked before (i.e. the link has been @e
visited).
*/
- void SetVisitedColour(const wxColour& colour);
+ virtual void SetVisitedColour(const wxColour& colour);
};
@warning
Do not delete an icon that is selected into a memory device context.
*/
- ~wxIcon();
+ virtual ~wxIcon();
/**
Copies @a bmp bitmap to this icon.
/**
Destructor.
*/
- ~wxIconBundle();
+ virtual ~wxIconBundle();
//@{
/**
/**
Destroys the wxImageHandler object.
*/
- ~wxImageHandler();
+ virtual ~wxImageHandler();
/**
Gets the file extension associated with this handler.
@return Number of available images. For most image handlers, this is 1
(exceptions are TIFF and ICO formats).
*/
- int GetImageCount(wxInputStream& stream);
+ virtual int GetImageCount(wxInputStream& stream);
/**
Gets the MIME type associated with this handler.
See @ref overview_refcountdestruct "reference-counted object destruction" for
more info.
*/
- ~wxImage();
+ virtual ~wxImage();
/**
Register an image handler.
@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
@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
@see Blur(), BlurHorizontal()
*/
- wxImage BlurVertical(int blurRadius);
+ wxImage BlurVertical(int blurRadius) const;
/**
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.
@return Returns @false if there is no unused colour left, @true on success.
*/
bool FindFirstUnusedColour(unsigned char* r, unsigned char* g,
- unsigned char* b,
- unsigned char startR = 1,
+ unsigned char* b, unsigned char startR = 1,
unsigned char startG = 0,
- unsigned char startB = 0);
+ unsigned char startB = 0) const;
//@{
/**
*/
wxImage Rotate(double angle, const wxPoint& rotationCentre,
bool interpolating = true,
- wxPoint* offsetAfterRotation = NULL);
+ wxPoint* offsetAfterRotation = NULL) const;
/**
Returns a copy of the image rotated 90 degrees in the direction
For optimisation - drawing can be faster if the function is told
that the background is solid.
*/
- bool Draw(int index, wxDC& dc, int x, int y,
- int flags = wxIMAGELIST_DRAW_NORMAL,
- bool solidBackground = false);
+ virtual bool Draw(int index, wxDC& dc, int x, int y,
+ int flags = wxIMAGELIST_DRAW_NORMAL,
+ bool solidBackground = false);
/**
Returns the bitmap corresponding to the given index.
/**
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
@return @true if the function succeeded, @false if it failed (for example,
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.
set locale is restored and so the changes described in
Init() documentation are rolled back.
*/
- ~wxLocale();
+ virtual ~wxLocale();
//@{
/**
(in this order).
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
/**
Destroys the wxJoystick object.
*/
- ~wxJoystick();
+ virtual ~wxJoystick();
//@{
/**
/**
Destructor.
*/
- ~wxLayoutAlgorithm();
+ virtual ~wxLayoutAlgorithm();
/**
Lays out the children of a normal frame. @a mainWindow is set to occupy the
remaining space.
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
area.
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.
and the window will be set
to the remaining size).
*/
- bool LayoutWindow(wxWindow* parent, wxWindow* mainWindow = NULL) const;
+ bool LayoutWindow(wxWindow* parent, wxWindow* mainWindow = NULL);
};
/**
Destructor, destroying the list box.
*/
- ~wxListBox();
+ virtual ~wxListBox();
//@{
/**
@see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection,
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
@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.
/**
Destructor, destroying the list control.
*/
- ~wxListCtrl();
+ virtual ~wxListCtrl();
/**
Arranges the items in icon or small icon view. This only has effect on Win32.
/**
Destroys the previous log target.
*/
- ~wxLogChain();
+ virtual ~wxLogChain();
/**
Detaches the old log target so it won't be destroyed when the wxLogChain object
Disables time stamping of the log messages.
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
/**
Destructor.
*/
- ~wxMDIClientWindow();
+ virtual ~wxMDIClientWindow();
/**
Used in two-step frame construction. See wxMDIClientWindow()
for further details.
*/
- bool CreateClient(wxMDIParentFrame* parent, long style = 0);
+ virtual bool CreateClient(wxMDIParentFrame* parent, long style = 0);
};
/**
Destructor. Destroys all child windows and menu bar if present.
*/
- ~wxMDIParentFrame();
+ virtual ~wxMDIParentFrame();
/**
Activates the MDI child following the currently active one.
@see ActivatePrevious()
*/
- void ActivateNext();
+ virtual void ActivateNext();
/**
Activates the MDI child preceding the currently active one.
@see ActivateNext()
*/
- void ActivatePrevious();
+ virtual void ActivatePrevious();
/**
Arranges any iconized (minimized) MDI child windows.
@see Cascade(), Tile()
*/
- void ArrangeIcons();
+ virtual void ArrangeIcons();
/**
Arranges the MDI child windows in a cascade.
@see Tile(), ArrangeIcons()
*/
- void Cascade();
+ virtual void Cascade();
/**
Used in two-step frame construction. See wxMDIParentFrame()
Currently only implemented for MSW, does nothing under the other platforms.
*/
- void Tile(wxOrientation orient = wxHORIZONTAL);
+ virtual void Tile(wxOrientation orient = wxHORIZONTAL);
};
/**
Destructor. Destroys all child windows and menu bar if present.
*/
- ~wxMDIChildFrame();
+ virtual ~wxMDIChildFrame();
/**
Activates this MDI child frame.
@see Maximize(), Restore()
*/
- void Activate();
+ virtual void Activate();
/**
Used in two-step frame construction. See wxMDIChildFrame()
/**
Restores this MDI child frame (unmaximizes).
*/
- void Restore();
+ virtual void Restore();
};
@param 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,
- long style = 0, const wxString& szBackend = wxT(""), const wxValidatorvalidator = wxDefaultValidator,
- const wxString& name = wxPanelNameStr );
+ long style = 0, const wxString& szBackend = wxT(""),
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = wxPanelNameStr);
/**
@param 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,
- long style = 0, const wxString& szBackend = wxT(""), const wxValidatorvalidator = wxDefaultValidator,
- const wxString& name = wxPanelNameStr );
+ long style = 0, const wxString& szBackend = wxT(""),
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = wxPanelNameStr);
/**
Obtains the best size relative to the original/natural size of the
Destructor, destroying the menu bar and removing it from the parent frame (if
any).
*/
- ~wxMenuBar();
+ virtual ~wxMenuBar();
/**
Adds the item to the end of the menu bar.
@see Insert()
*/
- bool Append(wxMenu* menu, const wxString& title);
+ virtual bool Append(wxMenu* menu, const wxString& title);
/**
Checks or unchecks a menu item.
@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.
@see Replace()
*/
- wxMenu* Remove(size_t pos);
+ virtual wxMenu* Remove(size_t pos);
/**
Replaces the menu at the given position with another one.
@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.
a different window from last time, which causes an implicit destruction
and recreation of internal data structures.
*/
- ~wxMenu();
+ virtual ~wxMenu();
/**
Adds a menu item.
AppendSubMenu(), Insert(), SetLabel(),
GetHelpString(), SetHelpString(), wxMenuItem
*/
- wxMenuItem* Append(int id, const wxString& item,
- wxMenu* subMenu,
+ wxMenuItem* Append(int id, const wxString& item, wxMenu* subMenu,
const wxString& helpString = wxEmptyString);
/**
Inserts a break in a menu, causing the next appended item to appear in a new
column.
*/
- void Break();
+ virtual void Break();
/**
Checks or unchecks the menu item.
@remarks Any special menu codes are stripped out of source and target
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,
@see SetHelpString(), Append()
*/
- wxString GetHelpString(int id) const;
+ virtual wxString GetHelpString(int id) const;
/**
Returns a menu item label.
@see GetHelpString()
*/
- void SetHelpString(int id, const wxString& helpString);
+ virtual void SetHelpString(int id, const wxString& helpString);
/**
Sets the label of a menu item.
@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
wxWindow::PopupMenu, but
the application may call it at other times if required.
*/
- void UpdateUI(wxEvtHandler* source = NULL) const;
+ void UpdateUI(wxEvtHandler* source = NULL);
};
/**
Destructor.
*/
- ~wxMenuItem();
+ virtual ~wxMenuItem();
/**
Checks or unchecks the menu item.
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.
*/
- void Enable(bool enable = true);
+ virtual void Enable(bool enable = true);
/**
Returns the background colour associated with the menu item (Windows only).
@see GetItemLabelText(), GetLabelText()
*/
- wxString GetItemLabel() const;
+ virtual wxString GetItemLabel() const;
/**
Returns the text associated with the menu item, without any accelerator
@see GetItemLabel(), GetLabelText()
*/
- wxString GetItemLabelText() const;
+ virtual wxString GetItemLabelText() const;
/**
Returns the item kind, one of @c wxITEM_SEPARATOR, @c wxITEM_NORMAL,
/**
Returns @true if the item is checked.
*/
- bool IsChecked() const;
+ virtual bool IsChecked() const;
/**
Returns @true if the item is enabled.
*/
- bool IsEnabled() const;
+ virtual bool IsEnabled() const;
/**
Returns @true if the item is a separator.
Sets the bitmap for the menu item (Windows and GTK+ only). It is
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 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 text associated with the menu item.
@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).
with a brief description for this file type: for example, "text document" for
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
and KDE settings and thus GetIcon's success depends on availability
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
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
/**
Destructor. Destroys all child windows and menu bar if present.
*/
- ~wxMiniFrame();
+ virtual ~wxMiniFrame();
/**
Used in two-step frame construction. See wxMiniFrame()
/**
Destructor.
*/
- ~wxModule();
+ virtual ~wxModule();
//@{
/**
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.
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.
dlg.SetMessage(_("Do you really want to quit?"));
@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,
Notice that this method returns the identifier of the button which was
clicked unlike wxMessageBox() function.
*/
- int ShowModal();
+ virtual int ShowModal();
};
/**
Destructor.
*/
- ~wxMemoryOutputStream();
+ virtual ~wxMemoryOutputStream();
/**
CopyTo allowed you to transfer data from the internal buffer of
/**
Destructor.
*/
- ~wxMemoryInputStream();
+ virtual ~wxMemoryInputStream();
/**
Returns the pointer to the stream object used as an internal buffer
@see AddPage()
*/
- bool InsertPage(size_t index, wxNotebookPage* page,
- const wxString& text,
- bool select = false,
- int imageId = -1);
+ virtual bool InsertPage(size_t index, wxNotebookPage* page,
+ const wxString& text, bool select = false,
+ int imageId = -1);
/**
An event handler function, called when the page selection is changed.
Sets the amount of space around each page's icon and label, in pixels.
@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
some
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
and also because the user may be able to close the notification.
Returns @false if an error occurred.
*/
- bool Show(int timeout = Timeout_Auto);
+ virtual bool Show(int timeout = Timeout_Auto);
};
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
This virtual function is redefined for every class that requires run-time
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.
/**
Destructor, destroying the owner-drawn combobox.
*/
- ~wxOwnerDrawnComboBox();
+ virtual ~wxOwnerDrawnComboBox();
//@{
/**
/**
Returns index to the widest item in the list.
*/
- int GetWidestItem() const;
+ virtual int GetWidestItem();
/**
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.
@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
/**
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.
/**
Destructor. Deletes any child windows before deleting the physical window.
*/
- ~wxPanel();
+ virtual ~wxPanel();
/**
This method is overridden from wxWindow::AcceptsFocus()
@see wxInitDialogEvent
*/
- void InitDialog();
+ virtual void InitDialog();
/**
The default handler for wxEVT_SYS_COLOUR_CHANGED.
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.
*/
- virtual void SetFocusIgnoringChildren();
+ void SetFocusIgnoringChildren();
};
pointer to the pen object is stored in an application
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
/**
Destructor.
*/
- ~wxPreviewControlBar();
+ virtual ~wxPreviewControlBar();
/**
Creates buttons, according to value of the button style flags.
@todo which flags??
*/
- void CreateButtons();
+ virtual void CreateButtons();
/**
Gets the print preview object associated with the control bar.
*/
- wxPrintPreview* GetPrintPreview();
+ virtual wxPrintPreviewBase* GetPrintPreview() const;
/**
Gets the current zoom setting in percent.
*/
- int GetZoomControl();
+ virtual int GetZoomControl();
/**
Sets the zoom control.
*/
- void SetZoomControl(int percent);
+ virtual void SetZoomControl(int percent);
};
/**
Destructor.
*/
- ~wxPreviewCanvas();
+ virtual ~wxPreviewCanvas();
/**
Calls wxPrintPreview::PaintPage() to refresh the canvas.
/**
Destructor.
*/
- ~wxPreviewFrame();
+ virtual ~wxPreviewFrame();
/**
Creates a wxPreviewCanvas.
Override this function to allow a user-defined preview canvas object
to be created.
*/
- void CreateCanvas();
+ virtual void CreateCanvas();
/**
Creates a wxPreviewControlBar.
Override this function to allow a user-defined preview control bar object
to be created.
*/
- void CreateControlBar();
+ virtual void CreateControlBar();
/**
Creates the preview canvas and control bar, and calls wxWindow::MakeModal(@true)
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
/**
Gets the preview window used for displaying the print preview image.
*/
- wxPreviewCanvas* GetCanvas();
+ virtual wxPreviewCanvas* GetCanvas() const;
/**
Gets the page currently being previewed.
*/
- int GetCurrentPage();
+ virtual int GetCurrentPage() const;
/**
Gets the frame used for displaying the print preview canvas
and control bar.
*/
- wxFrame* GetFrame();
+ virtual wxFrame* GetFrame() const;
/**
Returns the maximum page number.
*/
- int GetMaxPage();
+ virtual int GetMaxPage() const;
/**
Returns the minimum page number.
*/
- int GetMinPage();
+ virtual int GetMinPage() const;
/**
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
interface,
or @NULL if none exists.
*/
- wxPrintout* GetPrintoutForPrinting();
+ virtual wxPrintout* GetPrintoutForPrinting() const;
/**
Returns @true if the wxPrintPreview is valid, @false otherwise.
It could return @false if there was a problem initializing the printer
device context (current printer not set, for example).
*/
- bool IsOk();
+ virtual bool IsOk() const;
/**
This refreshes the preview window with the preview image.
Returns @false in case of error -- call wxPrinter::GetLastError()
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.
*/
- bool RenderPage(int pageNum);
+ virtual bool RenderPage(int pageNum);
/**
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 frame to be used for displaying the print preview canvas
and control bar.
*/
- void SetFrame(wxFrame* frame);
+ virtual void SetFrame(wxFrame* frame);
/**
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.
*/
- void SetZoom(int percent);
+ virtual void SetZoom(int percent);
};
/**
Returns @true if the user has aborted the print job.
*/
- bool GetAbort();
+ bool GetAbort() const;
/**
Return last error. Valid after calling Print(), PrintDialog() or
Returns the @ref overview_printing_printdata "print data" associated with
the printer object.
*/
- wxPrintDialogData& GetPrintDialogData();
+ virtual wxPrintDialogData& GetPrintDialogData() const;
/**
Starts the printing process. Provide a parent window, a user-defined wxPrintout
@remarks
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.
The setup dialog is obsolete from Windows 95, though retained
for backward compatibility.
*/
- bool Setup(wxWindow* parent);
+ virtual bool Setup(wxWindow* parent);
};
/**
Destructor.
*/
- ~wxPrintout();
+ virtual ~wxPrintout();
/**
Set the user scale and device origin of the wxDC associated with this wxPrintout
This will be a wxPrinterDC if printing under Windows or Mac, a wxPostScriptDC
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
The page margins are specified with respect to the edges of the paper on all
platforms.
*/
- wxRect GetLogicalPageMarginsRect(const wxPageSetupDialogData& pageSetupData);
+ wxRect GetLogicalPageMarginsRect(const wxPageSetupDialogData& pageSetupData) const;
/**
Return the rectangle corresponding to the page in the associated wxDC 's
On other platforms and PostScript printing, this will be the full paper
rectangle.
*/
- wxRect GetLogicalPageRect();
+ wxRect GetLogicalPageRect() const;
/**
Return the rectangle corresponding to the paper in the associated wxDC 's
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.
This method returns the output-only parameters as a tuple.
@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.
This method returns the output-only parameters as a tuple.
@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
This method returns the output-only parameters as a tuple.
@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.
This method returns the output-only parameters as a tuple.
@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
area were printable, so this function will return the same rectangle as the page
rectangle.
*/
- wxRect GetPaperRectPixels();
+ wxRect GetPaperRectPixels() const;
/**
Returns the title of the printout.
@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
Returning @false signifies the end of the document. By default,
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.
*/
- bool IsPreview();
+ virtual bool IsPreview() const;
/**
Set the user scale and device origin of the wxDC associated with this wxPrintout
be called by using the method <tt>base_OnBeginDocument(startPage, endPage)</tt>.
@endWxPythonOnly
*/
- bool OnBeginDocument(int startPage, int endPage);
+ virtual bool OnBeginDocument(int startPage, int endPage);
/**
Called by the framework at the start of printing.
OnBeginPrinting() is called once for every print job
(regardless of how many copies are being printed).
*/
- void OnBeginPrinting();
+ virtual void OnBeginPrinting();
/**
Called by the framework at the end of document printing.
The base OnEndDocument() must be called from within the overridden function,
since it calls wxDC::EndDoc().
*/
- void OnEndDocument();
+ virtual void OnEndDocument();
/**
Called by the framework at the end of printing.
OnEndPrinting is called once for every print job
(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
This gives the object an opportunity to calculate the number of pages
in the document, for example.
*/
- void OnPreparePrinting();
+ virtual void OnPreparePrinting();
/**
Called by the framework when a page should be printed. Returning @false cancels
If GetPrintDC() has not been called, the device context obtained by
the dialog (if any) will be deleted.
*/
- ~wxPrintDialog();
+ virtual ~wxPrintDialog();
/**
Returns the device context created by the print dialog, if any.
is transferred to the application, so it must then be deleted
explicitly.
*/
- wxDC* GetPrintDC();
+ virtual wxDC* GetPrintDC();
/**
Returns the @ref overview_printing_printdata "print dialog data" associated
After this function is called, a device context may be retrievable using
GetPrintDC().
*/
- int ShowModal();
+ virtual int ShowModal();
};
/**
Destructor.
*/
- ~wxPageSetupDialog();
+ virtual ~wxPageSetupDialog();
/**
Returns the wxPageSetupDialogData object associated with the dialog.
/**
Destroys the wxProcess object.
*/
- ~wxProcess();
+ virtual ~wxProcess();
/**
Closes the output stream (the one connected to the stdin of the child
@param status
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
/**
Returns the process id.
*/
- int GetPid() const;
+ int GetPid();
};
/**
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
@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.
*/
- void LayoutDialog(int centreFlags = wxBOTH);
+ virtual void LayoutDialog(int centreFlags = wxBOTH);
/**
Sets the book control used for the dialog.
/**
Destructor will close the connection if connected.
*/
- ~wxFTP();
+ virtual ~wxFTP();
/**
Aborts the download currently in process, returns @true if ok, @false
if an error occurred.
*/
- bool Abort();
+ virtual bool Abort();
/**
Change the current FTP working directory.
@return Returns @NULL if an error occurred (it could be a network failure
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.
@see wxOutputStream
*/
- wxOutputStream* GetOutputStream(const wxString& file);
+ virtual wxOutputStream* GetOutputStream(const wxString& file);
/**
Create the specified directory in the current FTP working directory.
/**
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 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);
};
The header is not case-sensitive, i.e. "CONTENT-TYPE" and "content-type"
represent the same header.
*/
- wxString GetHeader(const wxString& header);
+ wxString GetHeader(const wxString& header) const;
/**
Creates a new input stream on the specified path.
@see wxInputStream
*/
- wxInputStream* GetInputStream(const wxString& path);
+ virtual wxInputStream* GetInputStream(const wxString& path);
/**
Returns the HTTP response code returned by the server.
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.
/**
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.
/**
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.
*/
- void SetUser(const wxString& user);
+ virtual void SetUser(const wxString& user);
};
/**
Destructor, destroying the radiobox item.
*/
- ~wxRadioBox();
+ virtual ~wxRadioBox();
/**
Creates the radiobox for two-step construction. See wxRadioBox()
@param n
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
@param n
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.
/**
Destructor, destroying the radio button item.
*/
- ~wxRadioButton();
+ virtual ~wxRadioButton();
/**
Creates the choice for two-step construction. See wxRadioButton() for
/**
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
See @ref overview_refcount_destruct "reference-counted object destruction" for
more info.
*/
- ~wxRegion();
+ virtual ~wxRegion();
/**
Clears the current region.
*/
- void Clear();
+ virtual void Clear();
/**
Returns a value indicating whether the given point is contained within the region.
/**
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,
/**
Virtual destructor as for any base class.
*/
- ~wxRendererNative();
+ virtual ~wxRendererNative();
/**
Draw a check box.
/**
Destructor.
*/
- ~wxRichTextBuffer();
+ virtual ~wxRichTextBuffer();
/**
Adds an event handler to the buffer's list of handlers. A buffer associated with
/**
Adds a file handler.
*/
- void AddHandler(wxRichTextFileHandler* handler);
+ static void AddHandler(wxRichTextFileHandler* handler);
/**
Adds a paragraph of text.
Returns @true if the buffer is currently collapsing commands into a single
notional command.
*/
- bool BatchingUndo() const;
+ virtual bool BatchingUndo() const;
/**
Begins using alignment.
@a cmdName should be the name of the combined command that will appear
next to Undo and Redo in the edit menu.
*/
- bool BeginBatchUndo(const wxString& cmdName);
+ virtual bool BeginBatchUndo(const wxString& cmdName);
/**
Begin applying bold.
/**
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
history
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
/**
Returns @true if content can be pasted from the clipboard.
*/
- bool CanPasteFromClipboard() const;
+ virtual bool CanPasteFromClipboard() const;
/**
Cleans up the file handlers.
*/
- void CleanUpHandlers();
+ static void CleanUpHandlers();
/**
Clears the buffer.
/**
Clears the style stack.
*/
- void ClearStyleStack();
+ virtual void ClearStyleStack();
/**
Clones the object.
*/
- wxRichTextObject* Clone() const;
+ virtual wxRichTextObject* Clone() const;
/**
Copies the given buffer.
/**
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.
/**
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.
*/
- bool EndBatchUndo();
+ virtual bool EndBatchUndo();
/**
Ends using bold.
/**
Ends the current style.
*/
- bool EndStyle();
+ virtual bool EndStyle();
/**
Ends suppressing undo/redo commands.
*/
- bool EndSuppressUndo();
+ virtual bool EndSuppressUndo();
/**
Ends using a symbol bullet.
/**
Gets the collapsed command.
*/
- wxRichTextCommand* GetBatchedCommand() const;
+ virtual wxRichTextCommand* GetBatchedCommand() const;
/**
Gets the command processor. A text buffer always creates its own command
/**
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.
*/
- size_t GetStyleStackSize() const;
+ virtual size_t GetStyleStackSize() const;
/**
Gets the attributes at the given position.
loading/saving handler
is initialised by default.
*/
- void InitStandardHandlers();
+ static void InitStandardHandlers();
/**
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.
/**
Pastes the clipboard content to the buffer at the given position.
*/
- bool PasteFromClipboard(long position);
+ virtual bool PasteFromClipboard(long position);
//@{
/**
/**
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.
*/
- void ResetAndClearCommands();
+ virtual void ResetAndClearCommands();
//@{
/**
/**
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.
*/
- bool SuppressingUndo() const;
+ virtual bool SuppressingUndo() const;
};
filename. By default,
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.
*/
- bool CanLoad() const;
+ virtual bool CanLoad() const;
/**
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.
/**
Returns @true if this handler should be visible to the user.
*/
- bool IsVisible() const;
+ virtual bool IsVisible() const;
//@{
/**
load and save
dialogs).
*/
- void SetVisible(bool visible);
+ virtual void SetVisible(bool visible);
};
/**
Destructor.
*/
- ~wxRichTextCtrl();
+ virtual ~wxRichTextCtrl();
/**
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.
*/
- 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.
*/
- void AppendText(const wxString& text);
+ virtual void AppendText(const wxString& text);
/**
Applies the given alignment to the selection (undoable).
For alignment values, see wxTextAttr.
*/
- bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
+ virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
/**
Apples bold to the selection (undoable).
*/
- bool ApplyBoldToSelection();
+ virtual bool ApplyBoldToSelection();
/**
Applies italic to the selection (undoable).
*/
- bool ApplyItalicToSelection();
+ virtual bool ApplyItalicToSelection();
/**
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 underline to the selection (undoable).
*/
- bool ApplyUnderlineToSelection();
+ virtual bool ApplyUnderlineToSelection();
/**
Returns @true if undo commands are being batched.
*/
- bool BatchingUndo() const;
+ virtual bool BatchingUndo() const;
/**
Begins using alignment
/**
Starts batching undo history for commands.
*/
- bool BeginBatchUndo(const wxString& cmdName);
+ virtual bool BeginBatchUndo(const wxString& cmdName);
/**
Begins using bold.
/**
Begins applying a style.
*/
- bool BeginStyle(const wxTextAttr& style);
+ virtual bool BeginStyle(const wxTextAttr& style);
/**
Starts suppressing undo history for commands.
*/
- bool BeginSuppressUndo();
+ virtual bool BeginSuppressUndo();
/**
Begins applying a symbol bullet, using a character from the current font. See
/**
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.
*/
- bool CanCut() const;
+ virtual bool CanCut() const;
/**
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.
*/
- bool CanPaste() const;
+ virtual bool CanPaste() const;
/**
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.
*/
- bool CanUndo() const;
+ virtual bool CanUndo() const;
/**
Clears the buffer content, leaving a single empty paragraph. Cannot be undone.
*/
- void Clear();
+ virtual void Clear();
//@{
/**
/**
Sends the event to the control.
*/
- void Command(wxCommandEvent& event);
+ virtual void Command(wxCommandEvent& event);
/**
Copies the selected content (if any) to the clipboard.
*/
- void Copy();
+ virtual void Copy();
/**
Creates the underlying window.
Copies the selected content (if any) to the clipboard and deletes the selection.
This is undoable.
*/
- void Cut();
+ virtual void Cut();
/**
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 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
history.
*/
- void DiscardEdits();
+ virtual void DiscardEdits();
/**
Currently this simply returns @c wxSize(10, 10).
/**
Ends application of all styles in the current style stack.
*/
- bool EndAllStyles();
+ virtual bool EndAllStyles();
/**
Ends batching undo command history.
*/
- bool EndBatchUndo();
+ virtual bool EndBatchUndo();
/**
Ends using bold.
/**
Ends the current style.
*/
- bool EndStyle();
+ virtual bool EndStyle();
/**
Ends suppressing undo command history.
*/
- bool EndSuppressUndo();
+ virtual bool EndSuppressUndo();
/**
Ends applying a symbol bullet.
Helper function for finding the caret position for the next word. Direction
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
/**
Returns the current insertion point.
*/
- long GetInsertionPoint() const;
+ virtual long GetInsertionPoint() const;
/**
Returns the last position in the buffer.
*/
- wxTextPos GetLastPosition() const;
+ virtual wxTextPos GetLastPosition() const;
/**
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.
*/
- wxString GetLineText(long lineNo) const;
+ virtual wxString GetLineText(long lineNo) const;
/**
Transforms physical window position to logical (unscrolled) position.
/**
Returns the number of lines in the buffer.
*/
- int GetNumberOfLines() const;
+ virtual int GetNumberOfLines() const;
/**
Transforms logical (unscrolled) position to physical window position.
The end point of range is specified as the last character position of the span
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.
of text, plus one.
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 text within the current selection range, if any.
*/
- wxString GetStringSelection() const;
+ virtual wxString GetStringSelection() const;
/**
Gets the attributes at the given position.
the character
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
will fetch
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.
*/
- wxString GetValue() const;
+ virtual wxString GetValue() const;
/**
Internal helper function returning the line for the visible caret position. If
/**
Returns @true if there is a selection.
*/
- bool HasSelection() const;
+ virtual bool HasSelection() const;
//@{
/**
/**
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 the buffer has been modified.
*/
- bool IsModified() const;
+ virtual bool IsModified() const;
/**
Returns @true if the control is multiline.
Returns @true if all of the selection is aligned according to the specified
flag.
*/
- bool IsSelectionAligned(wxTextAttrAlignment alignment) const;
+ virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
/**
Returns @true if all of the selection is bold.
*/
- bool IsSelectionBold() const;
+ virtual bool IsSelectionBold();
/**
Returns @true if all of the selection is italic.
*/
- bool IsSelectionItalics() const;
+ virtual bool IsSelectionItalics();
/**
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
/**
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
setting the caret position. This function should not normally be required by the
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
wxRichTextLineBreakChar to text content,
or by typing Shift-Return.
*/
- bool LineBreak();
+ virtual bool LineBreak();
/**
Loads content into the control's buffer using the given type. If the specified
/**
Marks the buffer as modified.
*/
- void MarkDirty();
+ virtual void MarkDirty();
/**
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
/**
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.
*/
- bool MoveEnd(int flags = 0);
+ virtual bool MoveEnd(int flags = 0);
/**
Moves to the start of the buffer.
*/
- bool MoveHome(int flags = 0);
+ virtual bool MoveHome(int flags = 0);
/**
Moves left.
*/
- bool MoveLeft(int noPositions = 1, int flags = 0);
+ virtual bool MoveLeft(int noPositions = 1, int flags = 0);
/**
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.
*/
- bool MoveToLineEnd(int flags = 0);
+ virtual bool MoveToLineEnd(int flags = 0);
/**
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.
*/
- bool MoveToParagraphEnd(int flags = 0);
+ virtual bool MoveToParagraphEnd(int flags = 0);
/**
Moves to the start of the paragraph.
*/
- bool MoveToParagraphStart(int flags = 0);
+ virtual bool MoveToParagraphStart(int flags = 0);
/**
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().
*/
- bool Newline();
+ virtual bool Newline();
//@{
/**
/**
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.
*/
- bool PageUp(int noPages = 1, int flags = 0);
+ virtual bool PageUp(int noPages = 1, int flags = 0);
/**
Paints the background.
*/
- void PaintBackground(wxDC& dc);
+ virtual void PaintBackground(wxDC& dc);
/**
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
position.
*/
- void PositionCaret();
+ virtual void PositionCaret();
/**
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;
//@{
/**
/**
Redoes the current command.
*/
- void Redo();
+ virtual void Redo();
/**
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
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
/**
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.
*/
- void SelectAll();
+ virtual void SelectAll();
/**
Cancels any selection.
*/
- void SelectNone();
+ virtual void SelectNone();
/**
Sets @a attr as the default style and tells the control that the UI should
only affects the style currently being applied (for example, setting the default
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.
inserted
text is displayed.
*/
- bool SetDefaultStyle(const wxTextAttr& style);
+ virtual bool SetDefaultStyle(const wxTextAttr& style);
/**
Sets the default style to the style under the cursor.
/**
Makes the control editable, or not.
*/
- void SetEditable(bool editable);
+ virtual void SetEditable(bool editable);
/**
Sets the current filename.
Sets the font, and also the basic and default attributes (see
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 the insertion point.
*/
- void SetInsertionPoint(long pos);
+ virtual void SetInsertionPoint(long pos);
/**
Sets the insertion point to the end of the text control.
*/
- void SetInsertionPointEnd();
+ virtual void SetInsertionPointEnd();
//@{
/**
So, for example, to set the selection for a character at position 5, use the
range (5,6).
*/
- void SetSelection(long from, long to);
+ virtual void SetSelection(long from, long to);
/**
Sets the selection to the given range.
/**
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.
*/
- void ShowPosition(long pos);
+ virtual void ShowPosition(long pos);
/**
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.
/**
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.
*/
- 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.
*/
- bool WordRight(int noWords = 1, int flags = 0);
+ virtual bool WordRight(int noWords = 1, int flags = 0);
//@{
/**
/**
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.
*/
- long XYToPosition(long x, long y) const;
+ virtual long XYToPosition(long x, long y) const;
};
/**
Destructor.
*/
- ~wxRichTextFormattingDialogFactory();
+ virtual ~wxRichTextFormattingDialogFactory();
/**
Creates the main dialog buttons.
/**
Destructor.
*/
- ~wxRichTextFormattingDialog();
+ virtual ~wxRichTextFormattingDialog();
/**
Apply attributes to the given range, only changing attributes that need to be
/**
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.
*/
- wxTextAttr* GetDialogAttributes(wxWindow* win);
+ static wxTextAttr* GetDialogAttributes(wxWindow* win);
/**
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.
*/
- wxRichTextFormattingDialogFactory* GetFormattingDialogFactory();
+ static wxRichTextFormattingDialogFactory* GetFormattingDialogFactory();
/**
Returns the image list associated with the dialog, used for example if showing
that do not have common values in the given range
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.
*/
- wxRichTextStyleDefinition* GetStyleDefinition() const;
+ virtual wxRichTextStyleDefinition* GetStyleDefinition() const;
/**
Gets the associated style sheet, if any.
*/
- wxRichTextStyleSheet* GetStyleSheet() const;
+ virtual wxRichTextStyleSheet* GetStyleSheet() const;
/**
Sets the attributes to be edited.
creation.
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 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
@true.
*/
- bool SetStyleDefinition(const wxRichTextStyleDefinition& styleDef,
- wxRichTextStyleSheet* sheet,
- bool update = true);
+ virtual bool SetStyleDefinition(const wxRichTextStyleDefinition& styleDef,
+ wxRichTextStyleSheet* sheet,
+ bool update = true);
/**
Updates the display.
*/
- bool UpdateDisplay();
+ virtual bool UpdateDisplay();
};
/**
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.
Reset the file counter, in case, for example, the same names are required each
time
*/
- void SetFileCounter(int counter);
+ static void SetFileCounter(int counter);
/**
Sets the mapping for converting point sizes to HTML font sizes.
/**
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.
*/
- void OnPreparePrinting();
+ virtual void OnPreparePrinting();
/**
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.
/**
Determines whether tooltips will be shown.
*/
- void SetShowToolTips(bool show);
+ static void SetShowToolTips(bool show);
/**
Sets the associated style sheet.
/**
Destructor.
*/
- ~wxRichTextStyleDefinition();
+ virtual ~wxRichTextStyleDefinition();
/**
Returns the style on which this style is based.
/**
Destructor.
*/
- ~wxRichTextParagraphStyleDefinition();
+ virtual ~wxRichTextParagraphStyleDefinition();
/**
Returns the style that should normally follow this style.
/**
Destructor.
*/
- ~wxRichTextStyleListBox();
+ virtual ~wxRichTextStyleListBox();
/**
Applies the @e ith style to the associated rich text control.
/**
Destructor.
*/
- ~wxRichTextStyleComboCtrl();
+ virtual ~wxRichTextStyleComboCtrl();
/**
Returns the wxRichTextCtrl associated with this control.
/**
Destructor.
*/
- ~wxRichTextCharacterStyleDefinition();
+ virtual ~wxRichTextCharacterStyleDefinition();
};
/**
Destructor.
*/
- ~wxRichTextListStyleDefinition();
+ virtual ~wxRichTextListStyleDefinition();
/**
This function combines the given paragraph style with the list style's base
/**
Destructor.
*/
- ~wxRichTextStyleSheet();
+ virtual ~wxRichTextStyleSheet();
/**
Adds a definition to the character style list.
/**
Returns @true.
*/
- bool CanLoad() const;
+ virtual bool CanLoad() const;
/**
Returns @true.
*/
- bool CanSave() const;
+ virtual bool CanSave() const;
/**
Creates XML code for a given character or paragraph style.
/**
Destructor.
*/
- ~wxSashWindow();
+ virtual ~wxSashWindow();
/**
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.
*/
- int GetMaximumSizeY() const;
+ virtual int GetMaximumSizeY() const;
/**
Gets the minimum window size in the x direction.
*/
- int GetMinimumSizeX();
+ virtual int GetMinimumSizeX() const;
/**
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.
/**
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.
*/
- void SetMaximumSizeY(int min);
+ virtual void SetMaximumSizeY(int min);
/**
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.
*/
- void SetMinimumSizeY(int min);
+ virtual void SetMinimumSizeY(int min);
/**
Call this function to give the sash a border, or remove the border.
number. @false is returned if the call failed (for example, the port
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
the OnMakeConnection() member to return your own
derived connection object.
*/
- wxConnectionBase* MakeConnection(const wxString& host,
- const wxString& service,
- const wxString& topic);
+ virtual wxConnectionBase* MakeConnection(const wxString& host,
+ const wxString& service,
+ const wxString& topic);
/**
The type of wxTCPConnection returned from a MakeConnection() call can
as wxTCPConnection::OnAdvise. You may also want to
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.
*/
- bool ValidHost(const wxString& host);
+ virtual bool ValidHost(const wxString& host);
};
side of the connection having called @b Disconnect. Returns @true if
successful.
*/
- bool Disconnect();
+ virtual bool Disconnect();
//@{
/**
member to be called. Returns @true if the server okays it, @false
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
stopped. Causes the server connection's OnStopAdvise() member
to be called. Returns @true if the server okays it, @false otherwise.
*/
- bool StopAdvise(const wxString& item);
+ virtual bool StopAdvise(const wxString& item);
};
/**
Destructor, destroying the scrollbar.
*/
- ~wxScrollBar();
+ virtual ~wxScrollBar();
/**
Scrollbar creation function called by the scrollbar constructor.
@see SetScrollbar()
*/
- int GetPageSize() const;
+ virtual int GetPageSize() const;
/**
Returns the length of the scrollbar.
@see SetScrollbar()
*/
- int GetRange() const;
+ virtual int GetRange() const;
/**
Returns the current position of the scrollbar thumb.
@see SetThumbPosition()
*/
- int GetThumbPosition() const;
+ virtual int GetThumbPosition() const;
/**
Returns the thumb or 'view' size.
@see SetScrollbar()
*/
- int GetThumbSize() const;
+ virtual int GetThumbSize() const;
/**
Sets the scrollbar properties.
@see GetThumbPosition()
*/
- void SetThumbPosition(int viewStart);
+ virtual void SetThumbPosition(int viewStart);
};
/**
Deletes the user data and subsizer, if any.
*/
- ~wxSizerItem();
+ virtual ~wxSizerItem();
/**
Calculates the minimum desired size for the item, including any space
Destroy the window or the windows in a subsizer, depending on the type
of item.
*/
- void DeleteWindows();
+ virtual void DeleteWindows();
/**
Enable deleting the SizerItem without destroying the contained sizer.
/**
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.
*/
- wxSize GetSize() const;
+ virtual wxSize GetSize() const;
/**
If this item is tracking a sizer, return it. @NULL otherwise.
adjust the position and size of the item to be within that space
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 sizer tracked by this item.
+ @deprecated @todo provide deprecation description
*/
void SetSizer(wxSizer* sizer);
/**
The destructor.
*/
- ~wxSizer();
+ virtual ~wxSizer();
/**
Appends a child to the sizer.
Detaches all children from the sizer. If @a delete_windows is @true then
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
@see Remove()
*/
- bool Detach(wxWindow* window);
+ virtual bool Detach(wxWindow* window);
/**
Detach the child @a sizer from the sizer without destroying it.
@see Remove()
*/
- bool Detach(wxSizer* sizer);
+ virtual bool Detach(wxSizer* sizer);
/**
Detach a item at position @a index from the sizer without destroying it.
/**
Returns the current position of the sizer.
*/
- wxPoint GetPosition();
+ wxPoint GetPosition() const;
/**
Returns the current size of the sizer.
*/
- wxSize GetSize();
+ wxSize GetSize() const;
/**
Hides the child @a window.
keeping
the current dimension.
*/
- void Layout();
+ virtual void Layout();
/**
Same as Add(), but prepends the items to the beginning of the
@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
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
appropriately.
@see wxScrolled::SetScrollbars()
+ @deprecated @todo provide deprecation description
*/
void SetVirtualSizeHints(wxWindow* window);
/**
Returns the number of columns in the sizer.
*/
- int GetCols();
+ int GetCols() const;
/**
Returns the horizontal gap (in pixels) between cells in the sizer.
*/
- int GetHGap();
+ int GetHGap() const;
/**
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.
*/
- int GetVGap();
+ int GetVGap() const;
/**
Sets the number of columns in the sizer.
/**
Destructor, destroying the slider.
*/
- ~wxSlider();
+ virtual ~wxSlider();
/**
Clears the selection, for a slider with the @b wxSL_SELRANGE style.
@remarks Windows 95 only.
*/
- void ClearSel();
+ virtual void ClearSel();
/**
Clears the ticks.
@remarks Windows 95 only.
*/
- void ClearTicks();
+ virtual void ClearTicks();
/**
Used for two-step slider construction. See wxSlider()
@see SetLineSize()
*/
- int GetLineSize() const;
+ virtual int GetLineSize() const;
/**
Gets the maximum slider value.
@see GetMin(), SetRange()
*/
- int GetMax() const;
+ virtual int GetMax() const;
/**
Gets the minimum slider value.
@see GetMin(), SetRange()
*/
- int GetMin() const;
+ virtual int GetMin() const;
/**
Returns the page size.
@see SetPageSize()
*/
- int GetPageSize() const;
+ virtual int GetPageSize() const;
/**
Returns the selection end point.
@see GetSelStart(), SetSelection()
*/
- int GetSelEnd() const;
+ virtual int GetSelEnd() const;
/**
Returns the selection start point.
@see GetSelEnd(), SetSelection()
*/
- int GetSelStart() const;
+ virtual int GetSelStart() const;
/**
Returns the thumb length.
@see SetThumbLength()
*/
- int GetThumbLength() const;
+ virtual int GetThumbLength() const;
/**
Returns the tick frequency.
@see SetTickFreq()
*/
- int GetTickFreq() const;
+ virtual int GetTickFreq() const;
/**
Gets the current slider value.
@see GetMin(), GetMax(), SetValue()
*/
- int GetValue() const;
+ virtual int GetValue() const;
/**
Sets the line size for the slider.
@see GetLineSize()
*/
- void SetLineSize(int lineSize);
+ virtual void SetLineSize(int lineSize);
/**
Sets the page size for the slider.
@see GetPageSize()
*/
- void SetPageSize(int pageSize);
+ virtual void SetPageSize(int pageSize);
/**
Sets the minimum and maximum slider values.
@see GetMin(), GetMax()
*/
- void SetRange(int minValue, int maxValue);
+ virtual void SetRange(int minValue, int maxValue);
/**
Sets the selection.
@see GetSelStart(), GetSelEnd()
*/
- void SetSelection(int startPos, int endPos);
+ virtual void SetSelection(int startPos, int endPos);
/**
Sets the slider thumb length.
@see GetThumbLength()
*/
- void SetThumbLength(int len);
+ virtual void SetThumbLength(int len);
/**
Sets a tick position.
@see SetTickFreq()
*/
- void SetTick(int tickPos);
+ virtual void SetTick(int tickPos);
/**
Sets the tick mark frequency and position.
@see GetTickFreq()
*/
- void SetTickFreq(int n, int pos);
+ virtual void SetTickFreq(int n, int pos);
/**
Sets the slider position.
@param value
The slider position.
*/
- void SetValue(int value);
+ virtual void SetValue(int value);
};
/**
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.
*/
- wxString IPAddress();
+ virtual wxString IPAddress() const;
/**
Set address to localhost (127.0.0.1).
/**
Destructor (it doesn't close the accepted connections).
*/
- ~wxSocketServer();
+ virtual ~wxSocketServer();
/**
Accepts an incoming connection request, and creates a new wxSocketBase object
/**
Destructor. Please see wxSocketBase::Destroy().
*/
- ~wxSocketClient();
+ virtual ~wxSocketClient();
/**
Connects to a server using the specified address.
@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.
/**
Default destructor.
*/
- ~wxSockAddress();
+ virtual ~wxSockAddress();
/**
Delete all informations about the address.
*/
- void Clear();
+ virtual void Clear();
/**
Returns the length of the socket address.
Gets the client data of the socket which generated this event, as
set with wxSocketBase::SetClientData().
*/
- void* GetClientData();
+ void* GetClientData() const;
/**
Returns the socket object to which this event refers to. This makes
/**
Destructor. Please see wxSocketBase::Destroy().
*/
- ~wxDatagramSocket();
+ virtual ~wxDatagramSocket();
/**
This function reads a buffer of @a nbytes bytes from the socket.
/**
Destroys the wxSound object.
*/
- ~wxSound();
+ virtual ~wxSound();
/**
Constructs a wave object from a file or resource.
/**
Destructor, destroys the spin button control.
*/
- ~wxSpinButton();
+ virtual ~wxSpinButton();
/**
Scrollbar creation function called by the spin button constructor.
@see SetRange()
*/
- int GetMax() const;
+ virtual int GetMax() const;
/**
Returns the minimum permissible value.
@see SetRange()
*/
- int GetMin() const;
+ virtual int GetMin() const;
/**
Returns the current spin button value.
@see SetValue()
*/
- int GetValue() const;
+ virtual int GetValue() const;
/**
Sets the range of the spin button.
@see GetMin(), GetMax()
*/
- void SetRange(int min, int max);
+ virtual void SetRange(int min, int max);
/**
Sets the value of the spin button.
@param value
The value for the spin button.
*/
- void SetValue(int value);
+ virtual void SetValue(int value);
};
/**
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.
/**
Destroys the splash screen.
*/
- ~wxSplashScreen();
+ virtual ~wxSplashScreen();
/**
Returns the splash style (see wxSplashScreen() for
/**
Destroys the wxSplitterWindow and its children.
*/
- ~wxSplitterWindow();
+ virtual ~wxSplitterWindow();
/**
Creation function, for two-step construction. See wxSplitterWindow() for
@see SetSashGravity()
*/
- double GetSashGravity();
+ double GetSashGravity() const;
/**
Returns the current sash position.
@see SetSashPosition()
*/
- int GetSashPosition();
+ int GetSashPosition() const;
/**
Gets the split mode.
/**
Destructor, destroying the search control.
*/
- ~wxSearchCtrl();
+ virtual ~wxSearchCtrl();
/**
Returns a pointer to the search control's menu object or @NULL if there is no
button visibility value.
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
Destructor does nothing neither but should be virtual as this class is used as
a base one.
*/
- ~wxStackWalker();
+ virtual ~wxStackWalker();
/**
This function must be overrided to process the given frame.
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.
*/
- 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.
wxApp::OnFatalException.
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);
};
can't retrieve the parameters info even although the function does have
parameters).
*/
- size_t GetParamCount() const;
+ virtual size_t GetParamCount() const;
/**
Return @true if we have the file name and line number for this frame.
@see SetBitmap()
*/
- wxBitmap GetBitmap() const;
+ virtual wxBitmap GetBitmap() const;
/**
Returns the icon currently used in the control. Notice that this method can
@see SetIcon()
*/
- wxIcon GetIcon() const;
+ virtual wxIcon GetIcon() const;
/**
Sets the bitmap label.
/**
Destructor, destroying the group box.
*/
- ~wxStaticBox();
+ virtual ~wxStaticBox();
/**
Creates the static box for two-step construction. See wxStaticBox()
dimension of the static line, i.e. its height for a horizontal line or its
width for a vertical one.
*/
- int GetDefaultSize();
+ static int GetDefaultSize();
/**
Returns @true if the line is vertical, @false if horizontal.
/**
Destructor.
*/
- ~wxStatusBar();
+ virtual ~wxStatusBar();
/**
Creates the window, for two-step construction.
bigger than the height specified here depending on the size of the font used by
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
/**
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.
Retrieve whether or not autocompletion is hidden automatically when nothing
matches.
*/
- bool AutoCompGetAutoHide();
+ bool AutoCompGetAutoHide() const;
/**
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
item.
*/
- bool AutoCompGetChooseSingle();
+ bool AutoCompGetChooseSingle() const;
/**
Get currently selected item position in the auto-completion list
Retrieve whether or not autocompletion deletes any word characters
after the inserted text upon completion.
*/
- bool AutoCompGetDropRestOfWord();
+ bool AutoCompGetDropRestOfWord() const;
/**
Retrieve state of ignore case flag.
*/
- bool AutoCompGetIgnoreCase();
+ bool AutoCompGetIgnoreCase() const;
/**
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.
*/
- int AutoCompGetMaxWidth();
+ int AutoCompGetMaxWidth() const;
/**
Retrieve the auto-completion list separator character.
*/
- int AutoCompGetSeparator();
+ int AutoCompGetSeparator() const;
/**
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.
/**
Are there any redoable actions in the undo history?
*/
- bool CanRedo();
+ virtual bool CanRedo() const;
/**
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.
/**
Clear the selection.
*/
- void Clear();
+ virtual void Clear();
/**
Delete all text in the document.
/**
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.
/**
Cut the selection to the clipboard.
*/
- void Cut();
+ virtual void Cut();
/**
Delete back from the current position to the start of the line.
/**
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?
*/
- bool GetBackSpaceUnIndents();
+ bool GetBackSpaceUnIndents() const;
/**
Is drawing done first into a buffer or direct to the screen?
*/
- bool GetBufferedDraw();
+ bool GetBufferedDraw() const;
/**
Get the foreground colour of the caret.
*/
- wxColour GetCaretForeground();
+ wxColour GetCaretForeground() const;
/**
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.
*/
- wxColour GetCaretLineBackground();
+ wxColour GetCaretLineBackground() const;
/**
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.
*/
- int GetCaretPeriod();
+ int GetCaretPeriod() const;
/**
Can the caret preferred x position only be changed by explicit movement
commands?
*/
- bool GetCaretSticky();
+ bool GetCaretSticky() const;
/**
Returns the width of the insert mode caret.
*/
- int GetCaretWidth();
+ int GetCaretWidth() const;
/**
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.
*/
- int GetCodePage();
+ int GetCodePage() const;
/**
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.
*/
- int GetControlCharSymbol();
+ int GetControlCharSymbol() const;
/**
/**
Returns the position of the caret.
*/
- int GetCurrentPos();
+ int GetCurrentPos() const;
/**
Retrieve a pointer to the document object.
/**
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.
*/
- wxColour GetEdgeColour();
+ wxColour GetEdgeColour() const;
/**
Retrieve the column number which text should be kept within.
*/
- int GetEdgeColumn();
+ int GetEdgeColumn() const;
/**
Retrieve the edge highlight mode.
*/
- int GetEdgeMode();
+ int GetEdgeMode() const;
/**
Retrieve whether the maximum scroll position has the last
line at the bottom of the view.
*/
- bool GetEndAtLastLine();
+ bool GetEndAtLastLine() const;
/**
Retrieve the position of the last correctly styled character.
*/
- int GetEndStyled();
+ int GetEndStyled() const;
/**
Retrieve the display line at the top of the display.
*/
- int GetFirstVisibleLine();
+ int GetFirstVisibleLine() const;
/**
Is a header line expanded?
*/
- bool GetFoldExpanded(int line);
+ bool GetFoldExpanded(int line) const;
/**
Retrieve the fold level of a line.
*/
- int GetFoldLevel(int line);
+ int GetFoldLevel(int line) const;
/**
Find the parent line of a child line.
*/
- int GetFoldParent(int line);
+ int GetFoldParent(int line) const;
/**
Get the highlighted indentation guide column.
*/
- int GetHighlightGuide();
+ int GetHighlightGuide() const;
/**
Retrieve indentation size.
*/
- int GetIndent();
+ int GetIndent() const;
/**
Are the indentation guides visible?
/**
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
/**
Retrieve the degree of caching of layout information.
*/
- int GetLayoutCache();
+ int GetLayoutCache() const;
/**
Returns the number of characters in the document.
*/
- int GetLength();
+ int GetLength() const;
/**
Retrieve the lexing language of the document.
*/
- int GetLexer();
+ int GetLexer() const;
/**
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.
*/
- int GetLineCount();
+ int GetLineCount() const;
/**
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.
*/
- int GetLineIndentPosition(int line);
+ int GetLineIndentPosition(int line) const;
/**
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 extra styling information for a line.
*/
- int GetLineState(int line);
+ int GetLineState(int line) const;
/**
Is a line visible?
*/
- bool GetLineVisible(int line);
+ bool GetLineVisible(int line) const;
/**
Returns the size in pixels of the left margin.
*/
- int GetMarginLeft();
+ int GetMarginLeft() const;
/**
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.
*/
- int GetMarginRight();
+ int GetMarginRight() const;
/**
Retrieve the mouse click sensitivity of a margin.
*/
- bool GetMarginSensitive(int margin);
+ bool GetMarginSensitive(int margin) const;
/**
Retrieve the type of a margin.
*/
- int GetMarginType(int margin);
+ int GetMarginType(int margin) const;
/**
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.
*/
- int GetMaxLineState();
+ int GetMaxLineState() const;
/**
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?
*/
- bool GetModify();
+ bool GetModify() const;
/**
Get whether mouse gets captured.
*/
- bool GetMouseDownCaptures();
+ bool GetMouseDownCaptures() const;
/**
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.
*/
- bool GetOvertype();
+ bool GetOvertype() const;
/**
Get convert-on-paste setting
*/
- bool GetPasteConvertEndings();
+ bool GetPasteConvertEndings() const;
/**
Returns the print colour mode.
*/
- int GetPrintColourMode();
+ int GetPrintColourMode() const;
/**
Returns the print magnification.
*/
- int GetPrintMagnification();
+ int GetPrintMagnification() const;
/**
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,
interpreted as an int AFTER any '$()' variable replacement.
*/
- int GetPropertyInt(const wxString& key);
+ int GetPropertyInt(const wxString& key) const;
/**
In read-only mode?
*/
- bool GetReadOnly();
+ bool GetReadOnly() const;
/**
Get cursor type.
*/
- int GetSTCCursor();
+ int GetSTCCursor() const;
/**
Get internal focus flag.
*/
- bool GetSTCFocus();
+ bool GetSTCFocus() const;
/**
Retrieve the document width assumed for scrolling.
*/
- int GetScrollWidth();
+ int GetScrollWidth() const;
/**
Get the search flags used by SearchInTarget.
*/
- int GetSearchFlags();
+ int GetSearchFlags() const;
/**
Get the alpha of the selection.
*/
- int GetSelAlpha();
+ int GetSelAlpha() const;
/**
Retrieve the selected text.
/**
Returns the position at the end of the selection.
*/
- int GetSelectionEnd();
+ int GetSelectionEnd() const;
/**
Get the mode of the current selection.
*/
- int GetSelectionMode();
+ int GetSelectionMode() const;
/**
Returns the position at the start of the selection.
*/
- int GetSelectionStart();
+ int GetSelectionStart() const;
/**
Get error status.
*/
- int GetStatus();
+ int GetStatus() const;
/**
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.
*/
- int GetStyleBits();
+ int GetStyleBits() const;
/**
Retrieve the number of bits the current lexer needs for styling.
*/
- int GetStyleBitsNeeded();
+ int GetStyleBitsNeeded() const;
/**
Retrieve a buffer of cells.
/**
Does a tab pressed when caret is within indentation indent?
*/
- bool GetTabIndents();
+ bool GetTabIndents() const;
/**
Retrieve the visible size of a tab.
*/
- int GetTabWidth();
+ int GetTabWidth() const;
/**
Get the position that ends the target.
*/
- int GetTargetEnd();
+ int GetTargetEnd() const;
/**
Get the position that starts the target.
*/
- int GetTargetStart();
+ int GetTargetStart() const;
/**
Retrieve all the text in the document.
*/
- wxString GetText();
+ wxString GetText() const;
/**
Retrieve the number of characters in the document.
*/
- int GetTextLength();
+ int GetTextLength() const;
/**
Retrieve a range of text.
/**
Is drawing done in two phases with backgrounds drawn before foregrounds?
*/
- bool GetTwoPhaseDraw();
+ bool GetTwoPhaseDraw() const;
/**
Is undo history being collected?
*/
- bool GetUndoCollection();
+ bool GetUndoCollection() const;
/**
Returns the current UseAntiAliasing setting.
/**
Is the horizontal scroll bar visible?
*/
- bool GetUseHorizontalScrollBar();
+ bool GetUseHorizontalScrollBar() const;
/**
Retrieve whether tabs will be used in indentation.
*/
- bool GetUseTabs();
+ bool GetUseTabs() const;
/**
Is the vertical scroll bar visible?
*/
- bool GetUseVerticalScrollBar();
+ bool GetUseVerticalScrollBar() const;
/**
Are the end of line characters visible?
*/
- bool GetViewEOL();
+ bool GetViewEOL() const;
/**
Are white space characters currently visible?
Returns one of SCWS_* constants.
*/
- int GetViewWhiteSpace();
+ int GetViewWhiteSpace() const;
/**
Retrieve whether text is word wrapped.
*/
- int GetWrapMode();
+ int GetWrapMode() const;
/**
Retrive the start indent for wrapped lines.
*/
- int GetWrapStartIndent();
+ int GetWrapStartIndent() const;
/**
Retrive the display mode of visual flags for wrapped lines.
*/
- int GetWrapVisualFlags();
+ int GetWrapVisualFlags() const;
/**
Retrive the location of visual flags for wrapped lines.
*/
- int GetWrapVisualFlagsLocation();
+ int GetWrapVisualFlagsLocation() const;
/**
*/
- int GetXOffset();
+ int GetXOffset() const;
/**
Retrieve the zoom level.
*/
- int GetZoom();
+ int GetZoom() const;
/**
Set caret to start of a line and ensure it is visible.
/**
Retrieve the foreground colour of an indicator.
*/
- wxColour IndicatorGetForeground(int indic);
+ wxColour IndicatorGetForeground(int indic) const;
/**
Retrieve the style of an indicator.
*/
- int IndicatorGetStyle(int indic);
+ int IndicatorGetStyle(int indic) const;
/**
Set the foreground colour of an indicator.
/**
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?
*/
- int LineLength(int line);
+ int LineLength(int line) const;
/**
Scroll horizontally and vertically.
/**
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
/**
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 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.
*/
- int PositionFromPoint(wxPoint pt);
+ int PositionFromPoint(wxPoint pt) const;
/**
Find the position from a point within the window but return
/**
Redoes the next action on the undo history.
*/
- void Redo();
+ virtual void Redo();
/**
Register an image for use in autocompletion lists.
/**
Select all the text in the document.
*/
- void SelectAll();
+ virtual void SelectAll();
/**
Duplicate the selection. If selection empty duplicate the line containing the
Is the selection rectangular? The alternative is the more common stream
selection.
*/
- bool SelectionIsRectangle();
+ bool SelectionIsRectangle() const;
/**
Send a message to Scintilla
/**
Undo one action in the undo history.
*/
- void Undo();
+ virtual void Undo();
/**
Transform the selection to upper case.
@see wxFileConfig
*/
- wxString GetConfigDir() const;
+ virtual wxString GetConfigDir() const;
/**
Return the location of the applications global, i.e. not user-specific,
@see GetLocalDataDir()
*/
- wxString GetDataDir() const;
+ virtual wxString GetDataDir() const;
/**
Return the directory containing the current user's documents.
@since 2.7.0
*/
- wxString GetDocumentsDir() const;
+ virtual wxString GetDocumentsDir() const;
/**
Return the directory and the filename for the current executable.
- Windows: @c C:\\Programs\\AppFolder\\exename.exe
- Mac: @c /Programs/exename
*/
- wxString GetExecutablePath() const;
+ virtual wxString GetExecutablePath() const;
/**
@note This function is only available under Unix.
This is the same as GetDataDir() except
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
@see wxDynamicLibrary
*/
- wxString GetPluginsDir() const;
+ virtual wxString GetPluginsDir() const;
/**
Return the directory where the application resource files are located. The
@see GetLocalizedResourcesDir()
*/
- wxString GetResourcesDir() const;
+ virtual wxString GetResourcesDir() const;
/**
Return the directory for storing temporary files. To create unique temporary
@since 2.7.2
*/
- wxString GetTempDir() const;
+ virtual wxString GetTempDir() const;
/**
Return the directory for the user config files:
directory, otherwise GetUserDataDir() is
more appropriate.
*/
- wxString GetUserConfigDir() const;
+ virtual wxString GetUserConfigDir() const;
/**
Return the directory for the user-dependent application data files:
- Windows: @c C:\\Documents @c and @c Settings\\username\\Application @c Data\\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
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
*/
- wxString GetUserLocalDataDir() const;
+ virtual wxString GetUserLocalDataDir() const;
/**
@note This function is only available under Unix.
The other cases are not currently supported and @c wxCONV_FAILED
(defined as -1) is returned for them.
*/
- size_t GetMBNulLen() const;
+ virtual size_t GetMBNulLen() const;
/**
Returns the maximal value which can be returned by GetMBNulLen() for
/**
Destructor.
*/
- ~wxCountingOutputStream();
+ virtual ~wxCountingOutputStream();
/**
Returns the current size of the stream.
@see Read()
*/
- char GetChar();
+ virtual char GetChar();
/**
Returns the amount of available data in the buffer.
@see Read()
*/
- void PutChar(char c);
+ virtual void PutChar(char c);
/**
Reads a block of the specified size and stores the data in buffer.
different of the specified size, an error has occurred and
should be tested using GetLastError().
*/
- size_t Read(void* buffer, size_t size);
+ virtual size_t Read(void* buffer, size_t size);
/**
Copies data to @a buffer.
Writes a block of the specified size using data of buffer.
The data are cached in a buffer before being sent in one block to the stream.
*/
- size_t Write(const void* buffer, size_t size);
+ virtual size_t Write(const void* buffer, size_t size);
/**
See Read().
/**
Destructor.
*/
- ~wxOutputStream();
+ virtual ~wxOutputStream();
/**
Closes the stream, returning @false if an error occurs.
as a file, then the underlying resource is closed too if it is owned
by this stream, or left open otherwise.
*/
- bool Close();
+ virtual bool Close();
/**
Returns the number of bytes written during the last Write().
It may return 0 even if there is no error on the stream if it is
only temporarily impossible to write to it.
*/
- size_t LastWrite() const;
+ virtual size_t LastWrite() const;
/**
Puts the specified character in the output queue and increments the
/**
Destructor.
*/
- ~wxInputStream();
+ virtual ~wxInputStream();
/**
Returns @true if some data is available in the stream right now, so that
calling Read() wouldn't block.
*/
- bool CanRead() const;
+ virtual bool CanRead() const;
/**
Returns @true after an attempt has been made to read past the end of the
stream.
*/
- bool Eof() const;
+ virtual bool Eof() const;
/**
Returns the first character in the input queue and removes it,
/**
Returns the last number of bytes read.
*/
- size_t LastRead() const;
+ virtual size_t LastRead() const;
/**
Returns the first character in the input queue without removing it.
*/
- char Peek();
+ virtual char Peek();
/**
Reads the specified amount of bytes and stores the data in buffer.
/**
Destructor.
*/
- ~wxStreamBase();
+ virtual ~wxStreamBase();
/**
This function returns the last error.
@since 2.5.4
*/
- wxFileOffset GetLength() const;
+ virtual wxFileOffset GetLength() const;
/**
This function returns the size of the stream.
streams. In that cases, GetSize returns 0 so you should always test its
return value.
*/
- size_t GetSize() const;
+ virtual size_t GetSize() const;
/**
Returns @true if no error occurred on the stream.
/**
Returns @true if the streams supports seeking to arbitrary offsets.
*/
- bool IsSeekable() const;
+ virtual bool IsSeekable() const;
/**
Internal function. It is called when the stream wants to read data of the
/**
Appends the string literal @e psz with max length @e nLen.
*/
- wxString& Append(const char* psz, size_t nLen);
+ wxString& Append(const wchar_t* pwz);
/**
Appends the wide string literal @e psz with max length @e nLen.
/**
Appends the string @e s.
*/
- wxString &Append(const wxString &s);
+ wxString& Append(const wchar_t* pwz, size_t nLen);
/**
Appends the character @e ch @e count times.
wxString& operator<<(const char* psz)
wxString& operator<<(const wchar_t* pwz)
wxString& operator<<(const wxCStrData& psz)
- wxString& operator<<(wxUniChar ch);
+ wxString& operator<<(const char* psz);
wxString& operator<<(wxUniCharRef ch)
wxString& operator<<(char ch)
wxString& operator<<(unsigned char ch)
wxString& operator<<(wchar_t ch)
wxString& operator<<(const wxCharBuffer& s)
wxString& operator<<(const wxWCharBuffer& s)
- wxString& operator<<(int i);
+ wxString& operator<<(wxUniCharRef ch);
wxString& operator<<(unsigned int ui);
wxString& operator<<(long l);
wxString& operator<<(unsigned long ul);
@see SetOption(), GetOptionInt(),
HasOption()
*/
- wxString GetOption(const wxString& name) const;
+ static wxString GetOption(const wxString& name);
/**
Gets an option as an integer. The function is case-insensitive to @e name.
@see SetOption(), GetOption(),
HasOption()
*/
- int GetOptionInt(const wxString& name) const;
+ static int GetOptionInt(const wxString& name);
/**
Returns @true if the given option is present. The function is
@see SetOption(), GetOption(),
GetOptionInt()
*/
- bool HasOption(const wxString& name) const;
+ static bool HasOption(const wxString& name);
/**
Returns @true if the option with the given @a name had been set to 0
@c GetOptionInt(name) == 0 as this would also be @true if the option
hadn't been set at all.
*/
- bool IsFalse(const wxString& name) const;
+ static bool IsFalse(const wxString& name);
//@{
/**
The destructor calls Close() to finish
writing the tar if it has not been called already.
*/
- ~wxTarOutputStream();
+ virtual ~wxTarOutputStream();
/**
Finishes writing the tar, returning @true if successful.
/**
Destroys the wxTaskBarIcon object, removing the icon if not already removed.
*/
- ~wxTaskBarIcon();
+ virtual ~wxTaskBarIcon();
/**
This method is called by the library when the user requests popup menu
/**
Returns @true if SetIcon() was called with no subsequent RemoveIcon().
*/
- bool IsIconInstalled();
+ bool IsIconInstalled() const;
/**
Returns @true if the object initialized successfully.
*/
- bool IsOk();
+ bool IsOk() const;
/**
Pops up a menu at the current mouse position. The events can be handled by
a class derived from wxTaskBarIcon.
*/
- bool PopupMenu(wxMenu* menu);
+ virtual bool PopupMenu(wxMenu* menu);
/**
Removes the icon previously set with SetIcon().
*/
- bool RemoveIcon();
+ virtual bool RemoveIcon();
/**
Sets the icon, and optional tooltip text.
/**
Destructor, destroying the text control.
*/
- ~wxTextCtrl();
+ virtual ~wxTextCtrl();
/**
Appends the text to the end of the text control.
Resets the internal modified flag as if the current changes had been
saved.
*/
- void DiscardEdits();
+ virtual void DiscardEdits();
/**
This functions inserts into the control the character which would have
@true if the event resulted in a change to the control, @false
otherwise.
*/
- bool EmulateKeyPress(const wxKeyEvent& event);
+ virtual bool EmulateKeyPress(const wxKeyEvent& event);
/**
Returns the style currently used for the new text.
@return
The length of the line, or -1 if @a lineNo was invalid.
*/
- int GetLineLength(long lineNo) const;
+ virtual int GetLineLength(long lineNo) const;
/**
Returns the contents of a given line in the text control, not including
@return
The contents of the line.
*/
- wxString GetLineText(long lineNo) const;
+ virtual wxString GetLineText(long lineNo) const;
/**
Returns the number of lines in the text control buffer.
insertion point is), so GetNumberOfLines() never
returns 0.
*/
- int GetNumberOfLines() const;
+ virtual int GetNumberOfLines() const;
/**
Returns the string containing the text starting in the positions
@see SetStyle(), wxTextAttr
*/
- bool GetStyle(long position, wxTextAttr& style);
+ virtual bool GetStyle(long position, wxTextAttr& style);
/**
Gets the contents of the control.
by (Unix-style) @c \\n characters, even under Windows where they are
separated by a @c \\r\\n sequence in the native control.
*/
- wxString GetValue() const;
+ virtual wxString GetValue() const;
/**
This function finds the character at the specified position expressed
In other words, this functions returns @true if the control hasn't been
put in read-only mode by a previous call to SetEditable().
*/
- bool IsEditable() const;
+ virtual bool IsEditable() const;
/**
Returns @true if the control is currently empty.
@since 2.7.1
*/
- bool IsEmpty() const;
+ virtual bool IsEmpty() const;
/**
Returns @true if the text has been modified by user.
@see MarkDirty()
*/
- bool IsModified() const;
+ virtual bool IsModified() const;
/**
Returns @true if this is a multi line edit control and @false
@see IsModified()
*/
- void MarkDirty();
+ virtual void MarkDirty();
/**
This event handler function implements default drag and drop behaviour,
@see XYToPosition()
*/
- bool PositionToXY(long pos, long* x, long* y) const;
+ virtual bool PositionToXY(long pos, long* x, long* y) const;
/**
If there is a redo facility and the last operation can be redone,
@see GetDefaultStyle()
*/
- bool SetDefaultStyle(const wxTextAttr& style);
+ virtual bool SetDefaultStyle(const wxTextAttr& style);
/**
Makes the text item editable or read-only, overriding the
@see GetStyle(), wxTextAttr
*/
- bool SetStyle(long start, long end, const wxTextAttr& style);
+ virtual bool SetStyle(long start, long end, const wxTextAttr& style);
/**
Sets the text value and marks the control as not-modified (which means
@param pos
The position that should be visible.
*/
- void ShowPosition(long pos);
+ virtual void ShowPosition(long pos);
/**
If there is an undo facility and the last operation can be undone,
allowed, and they will cause appropriate line breaks. See () and
AppendText() for more convenient ways of writing to the window.
*/
- void WriteText(const wxString& text);
+ virtual void WriteText(const wxString& text);
/**
Converts the given zero based column and line number to a position.
@return
The position value, or -1 if x or y was invalid.
*/
- long XYToPosition(long x, long y);
+ virtual long XYToPosition(long x, long y) const;
//@{
/**
/**
Destructor.
*/
- ~wxTextEntryDialog();
+ virtual ~wxTextEntryDialog();
/**
Returns the text that the user has entered if the user has pressed OK, or the
/**
Constructor does not load the file into memory, use Open() to do it.
*/
- wxTextFile(const wxString& strFile) const;
+ wxTextFile(const wxString& strFile);
/**
Destructor does nothing.
*/
- ~wxTextFile() const;
+ virtual ~wxTextFile();
/**
Adds a line to the end of file.
@return Returns @true if it is pressed, @false otherwise.
*/
- bool GetValue() const;
+ virtual bool GetValue() const;
/**
Sets the toggle button to the given state. This does not cause a
@param state
If @true, the button is pressed.
*/
- void SetValue(bool state);
+ virtual void SetValue(bool state);
};
/**
The destructor frees the resources associated with the thread.
*/
- ~wxThreadHelper();
+ virtual ~wxThreadHelper();
/**
Creates a new thread. The thread object is created in the suspended state, and
This is a public function that returns the wxThread object
associated with the thread.
*/
- wxThread* GetThread();
+ wxThread* GetThread() const;
/**
wxThread * m_thread
will not delete the C++ thread object. It is also safe to allocate them on
stack.
*/
- ~wxThread();
+ virtual ~wxThread();
/**
Creates a new thread. The thread object is created in the suspended state,
@ref Kill() killed.
This function should never be called directly.
*/
- void OnExit();
+ virtual void OnExit();
/**
Suspends the thread. Under some implementations (Win32), the thread is
information.
See also Sleep().
*/
- void Yield();
+ static void Yield();
};
/**
/**
Destructor. Stops the timer if it is running.
*/
- ~wxTimer();
+ virtual ~wxTimer();
/**
Returns the ID of the events generated by this timer.
used and SetOwner() wasn't called.
Perform whatever action which is to be taken periodically here.
*/
- void Notify();
+ virtual void Notify();
/**
Associates the timer with the given @a owner object. When the timer is
If the timer was already running, it will be stopped by this method before
restarting it.
*/
- bool Start(int milliseconds = -1, bool oneShot = false);
+ virtual bool Start(int milliseconds = -1, bool oneShot = false);
/**
Stops the timer.
*/
- void Stop();
+ virtual void Stop();
};
@since 2.7.0
*/
- wxChar GetLastDelimiter();
+ wxChar GetLastDelimiter() const;
/**
Returns the next token or empty string if the end of string was reached.
*/
- wxString GetNextToken() const;
+ wxString GetNextToken();
/**
Returns the current position (i.e. one index after the last returned
/**
Toolbar destructor.
*/
- ~wxToolBar();
+ virtual ~wxToolBar();
/**
Adds a new check (or toggle) tool to the toolbar. The parameters are the
@see AddSeparator(), AddCheckTool(), AddRadioTool(),
InsertTool(), DeleteTool(), Realize(), SetDropdownMenu()
*/
- wxToolBarToolBase* AddTool(wxToolBarToolBase* tool);
+ virtual wxToolBarToolBase* AddTool(wxToolBarToolBase* tool);
/**
Adds a tool to the toolbar. This most commonly used version has fewer
/**
Deletes all the tools in the toolbar.
*/
- void ClearTools();
+ virtual void ClearTools();
/**
Removes the specified tool from the toolbar and deletes it. If you don't
@see DeleteToolByPos()
*/
- bool DeleteTool(int toolId);
+ virtual bool DeleteTool(int toolId);
/**
This function behaves like DeleteTool() but it deletes the tool at the
specified position and not the one with the given id.
*/
- bool DeleteToolByPos(size_t pos);
+ virtual bool DeleteToolByPos(size_t pos);
/**
Enables or disables the tool.
@see GetToolEnabled(), ToggleTool()
*/
- void EnableTool(int toolId, bool enable);
+ virtual void EnableTool(int toolId, bool enable);
/**
Returns a pointer to the tool identified by @a id or @NULL if no
corresponding tool is found.
*/
- wxToolBarToolBase* FindById(int id);
+ wxToolBarToolBase* FindById(int id) const;
/**
Returns a pointer to the control identified by @a id or @NULL if no
corresponding control is found.
*/
- wxControl* FindControl(int id);
+ virtual wxControl* FindControl(int id);
/**
Finds a tool for the given mouse position.
@remarks Currently not implemented in wxGTK (always returns @NULL
there).
*/
- wxToolBarToolBase* FindToolForPosition(wxCoord x, wxCoord y) const;
+ virtual wxToolBarToolBase* FindToolForPosition(wxCoord x, wxCoord y) const;
/**
Returns the left/right and top/bottom margins, which are also used for
@see SetToolBitmapSize(), GetToolSize()
*/
- wxSize GetToolBitmapSize();
+ virtual wxSize GetToolBitmapSize() const;
/**
Get any client data associated with the tool.
@return Client data, or @NULL if there is none.
*/
- wxObject* GetToolClientData(int toolId) const;
+ virtual wxObject* GetToolClientData(int toolId) const;
/**
Called to determine whether a tool is enabled (responds to user input).
@see EnableTool()
*/
- bool GetToolEnabled(int toolId) const;
+ virtual bool GetToolEnabled(int toolId) const;
/**
Returns the long help for the given tool.
@see SetToolLongHelp(), SetToolShortHelp()
*/
- wxString GetToolLongHelp(int toolId) const;
+ virtual wxString GetToolLongHelp(int toolId) const;
/**
Returns the value used for packing tools.
@see SetToolPacking()
*/
- int GetToolPacking() const;
+ virtual int GetToolPacking() const;
/**
Returns the tool position in the toolbar, or @c wxNOT_FOUND if the tool
is not found.
*/
- int GetToolPos(int toolId) const;
+ virtual int GetToolPos(int toolId) const;
/**
Returns the default separator size.
@see SetToolSeparation()
*/
- int GetToolSeparation() const;
+ virtual int GetToolSeparation() const;
/**
Returns the short help for the given tool.
@see GetToolLongHelp(), SetToolShortHelp()
*/
- wxString GetToolShortHelp(int toolId) const;
+ virtual wxString GetToolShortHelp(int toolId) const;
/**
Returns the size of a whole button, which is usually larger than a tool
@see SetToolBitmapSize(), GetToolBitmapSize()
*/
- wxSize GetToolSize();
+ virtual wxSize GetToolSize() const;
/**
Gets the on/off state of a toggle tool.
@see ToggleTool()
*/
- bool GetToolState(int toolId) const;
+ virtual bool GetToolState(int toolId) const;
/**
Returns the number of tools in the toolbar.
@see AddSeparator(), InsertTool()
*/
- wxToolBarToolBase* InsertSeparator(size_t pos);
+ virtual wxToolBarToolBase* InsertSeparator(size_t pos);
//@{
/**
@see OnMouseEnter(), OnRightClick()
*/
- bool OnLeftClick(int toolId, bool toggleDown);
+ virtual bool OnLeftClick(int toolId, bool toggleDown);
/**
This is called when the mouse cursor moves into a tool or out of the
out of the toolbar, wxWidgets may not be able to detect it.
Therefore this function may not always be called when expected.
*/
- void OnMouseEnter(int toolId);
+ virtual void OnMouseEnter(int toolId);
/**
@deprecated This is the old way of detecting tool right clicks;
/**
This function should be called after you have added tools.
*/
- bool Realize();
+ virtual bool Realize();
/**
Removes the given tool from the toolbar but doesn't delete it. This
@see DeleteTool()
*/
- wxToolBarToolBase* RemoveTool(int id);
+ virtual wxToolBarToolBase* RemoveTool(int id);
/**
Sets the bitmap resource identifier for specifying tool bitmaps as
@see GetMargins()
*/
- void SetMargins(int x, int y);
+ virtual void SetMargins(int x, int y);
/**
Set the margins for the toolbar.
@see GetToolBitmapSize(), GetToolSize()
*/
- void SetToolBitmapSize(const wxSize& size);
+ virtual void SetToolBitmapSize(const wxSize& size);
/**
Sets the client data associated with the tool.
*/
- void SetToolClientData(int id, wxObject* clientData);
+ virtual void SetToolClientData(int id, wxObject* clientData);
/**
Sets the bitmap to be used by the tool with the given ID when the tool
have no effect on those platforms.
*/
- void SetToolDisabledBitmap(int id, const wxBitmap& bitmap);
+ virtual void SetToolDisabledBitmap(int id, const wxBitmap& bitmap);
/**
Sets the long help for the given tool.
@see GetToolLongHelp(), SetToolShortHelp(),
*/
- void SetToolLongHelp(int toolId, const wxString& helpString);
+ virtual void SetToolLongHelp(int toolId, const wxString& helpString);
/**
Sets the bitmap to be used by the tool with the given ID. This can only
be used on Button tools, not controls.
*/
- void SetToolNormalBitmap(int id, const wxBitmap& bitmap);
+ virtual void SetToolNormalBitmap(int id, const wxBitmap& bitmap);
/**
Sets the value used for spacing tools. The default value is 1.
@see GetToolPacking()
*/
- void SetToolPacking(int packing);
+ virtual void SetToolPacking(int packing);
/**
Sets the default separator size. The default value is 5.
@see AddSeparator()
*/
- void SetToolSeparation(int separation);
+ virtual void SetToolSeparation(int separation);
/**
Sets the short help for the given tool.
@see GetToolShortHelp(), SetToolLongHelp()
*/
- void SetToolShortHelp(int toolId, const wxString& helpString);
+ virtual void SetToolShortHelp(int toolId, const wxString& helpString);
/**
Toggles a tool on or off. This does not cause any event to get emitted.
@remarks Only applies to a tool that has been specified as a toggle
tool.
*/
- void ToggleTool(int toolId, bool toggle);
+ virtual void ToggleTool(int toolId, bool toggle);
};
Returns @true if this window is currently active, i.e. if the user is
currently working with it.
*/
- bool IsActive() const;
+ virtual bool IsActive();
/**
Returns @true if this window is expected to be always maximized, either
supporting it.
*/
- void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
+ virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
/**
Changes the default item for the panel, usually @a win is a button.
@see wxIconBundle.
*/
- void SetIcons(const wxIconBundle& icons);
+ virtual void SetIcons(const wxIconBundle& icons);
/**
Sets action or menu activated by pressing left hardware button on the
/**
A simpler interface for setting the size hints than SetSizeHints().
*/
- void SetMaxSize(const wxSize& size);
+ virtual void SetMaxSize(const wxSize& size);
/**
A simpler interface for setting the size hints than SetSizeHints().
*/
- void SetMinSize(const wxSize& size);
+ virtual void SetMinSize(const wxSize& size);
/**
Sets action or menu activated by pressing right hardware button on the
window to the normal rectangular shape simply call SetShape() again with
an empty wxRegion. Returns @true if the operation is successful.
*/
- bool SetShape(const wxRegion& region);
+ virtual bool SetShape(const wxRegion& region);
/**
Allows specification of minimum and maximum window sizes, and window
/**
Virtual destructor.
*/
- ~wxTreeItemData();
+ virtual ~wxTreeItemData();
/**
Returns the item associated with this node.
Destroys the wxTreebook object. Also deletes all the pages owned by the
control (inserted previously into it).
*/
- ~wxTreebook();
+ virtual ~wxTreebook();
/**
Adds a new page. The page is placed at the topmost level after all other
pages. @NULL could be specified for page to create an empty page.
*/
- bool AddPage(wxWindow* page, const wxString& text,
- bool bSelect = false,
- int imageId = wxNOT_FOUND);
+ virtual bool AddPage(wxWindow* page, const wxString& text,
+ bool bSelect = false, int imageId = wxNOT_FOUND);
/**
Adds a new child-page to the last top-level page. @NULL could be
specified for page to create an empty page.
*/
- bool AddSubPage(wxWindow* page, const wxString& text,
- bool bSelect = false,
- int imageId = wxNOT_FOUND);
+ virtual bool AddSubPage(wxWindow* page, const wxString& text,
+ bool bSelect = false, int imageId = wxNOT_FOUND);
/**
Sets the image list for the page control and takes ownership of the
@see wxImageList, SetImageList()
*/
- void AssignImageList(wxImageList* imageList);
+ virtual void AssignImageList(wxImageList* imageList);
/**
Changes the selection for the given page, returning the previous
This is the only difference with SetSelection(). See
@ref overview_eventhandling_prog for more info.
*/
- int ChangeSelection(size_t page);
+ virtual int ChangeSelection(size_t page);
/**
Shortcut for @ref wxTreebook::ExpandNode() "ExpandNode"( @a pageId,
/**
Deletes all pages inserted into the treebook. No event is generated.
*/
- bool DeleteAllPages();
+ virtual bool DeleteAllPages();
/**
Deletes the page at the specified position and all its children. Could
trigger page selection change in a case when selected page is removed.
In that case its parent is selected (or the next page if no parent).
*/
- bool DeletePage(size_t pagePos);
+ virtual bool DeletePage(size_t pagePos);
/**
Expands (collapses) the @a pageId node. Returns the previous state. May
generate page changing events (if selected page is under the collapsed
branch, then its parent is autoselected).
*/
- bool ExpandNode(size_t pageId, bool expand = true);
+ virtual bool ExpandNode(size_t pageId, bool expand = true);
/**
Returns the image index for the given page.
*/
- int GetPageImage(size_t n) const;
+ virtual int GetPageImage(size_t n) const;
/**
Returns the parent page of the given one or @c wxNOT_FOUND if this is a
/**
Returns the string for the given page.
*/
- wxString GetPageText(size_t n) const;
+ virtual wxString GetPageText(size_t n) const;
/**
Returns the currently selected page, or @c wxNOT_FOUND if none was
depending on the platform and so wxBookCtrlEvent::GetSelection()
should be used instead in this case.
*/
- int GetSelection() const;
+ virtual int GetSelection() const;
/**
Inserts a new page just before the page indicated by @a pagePos. The new
page is placed before @a pagePos page and on the same level. @NULL could
be specified for page to create an empty page.
*/
- bool InsertPage(size_t pagePos, wxWindow* page,
- const wxString& text,
- bool bSelect = false,
- int imageId = wxNOT_FOUND);
+ virtual bool InsertPage(size_t pagePos, wxWindow* page,
+ const wxString& text, bool bSelect = false,
+ int imageId = wxNOT_FOUND);
/**
Inserts a sub page under the specified page.
@NULL could be specified for page to create an empty page.
*/
- bool InsertSubPage(size_t pagePos, wxWindow* page,
- const wxString& text,
- bool bSelect = false,
- int imageId = wxNOT_FOUND);
+ virtual bool InsertSubPage(size_t pagePos, wxWindow* page,
+ const wxString& text, bool bSelect = false,
+ int imageId = wxNOT_FOUND);
/**
Returns @true if the page represented by @a pageId is expanded.
*/
- bool IsNodeExpanded(size_t pageId) const;
+ virtual bool IsNodeExpanded(size_t pageId) const;
/**
Sets the image list for the page control. It does not take ownership of
@see wxImageList, AssignImageList()
*/
- void SetImageList(wxImageList* imageList);
+ virtual void SetImageList(wxImageList* imageList);
/**
Sets the image index for the given @a page. @a imageId is an index into
the image list which was set with SetImageList().
*/
- bool SetPageImage(size_t page, int imageId);
+ virtual bool SetPageImage(size_t page, int imageId);
/**
Sets the @a text for the given @a page.
*/
- bool SetPageText(size_t page, const wxString& text);
+ virtual bool SetPageText(size_t page, const wxString& text);
/**
@deprecated Please use ChangeSelection() instead.
@see GetSelection(), ChangeSelection()
*/
- int SetSelection(size_t n);
+ virtual int SetSelection(size_t n);
};
/**
Destructor, destroying the tree control.
*/
- ~wxTreeCtrl();
+ virtual ~wxTreeCtrl();
/**
Adds the root node to the tree, returning the new item.
items, respectively. If @a image -1 and @a selImage is -1, the same
image is used for both selected and unselected items.
*/
- wxTreeItemId AddRoot(const wxString& text, int image = -1,
- int selImage = -1,
- wxTreeItemData* data = NULL);
+ virtual wxTreeItemId AddRoot(const wxString& text, int image = -1,
+ int selImage = -1,
+ wxTreeItemData* data = NULL);
/**
Appends an item to the end of the branch identified by @a parent, return
/**
Collapses the given item.
*/
- void Collapse(const wxTreeItemId& item);
+ virtual void Collapse(const wxTreeItemId& item);
/**
Collapses the root item.
/**
Collapses the given item and removes all children.
*/
- void CollapseAndReset(const wxTreeItemId& item);
+ virtual void CollapseAndReset(const wxTreeItemId& item);
/**
Creates the tree control. See wxTreeCtrl::wxTreeCtrl() for further
This function may cause a subsequent call to GetNextChild() to fail.
*/
- void Delete(const wxTreeItemId& item);
+ virtual void Delete(const wxTreeItemId& item);
/**
Deletes all items in the control. Note that this may not generate
EVT_TREE_DELETE_ITEM() events under some Windows versions although
normally such event is generated for each removed item.
*/
- void DeleteAllItems();
+ virtual void DeleteAllItems();
/**
Deletes all children of the given item (but not the item itself). Note
If you have called SetItemHasChildren(), you may need to call it again
since DeleteChildren() does not automatically clear the setting.
*/
- void DeleteChildren(const wxTreeItemId& item);
+ virtual void DeleteChildren(const wxTreeItemId& item);
/**
Starts editing the label of the given @a item. This function generates a
/**
Scrolls and/or expands items to ensure that the given item is visible.
*/
- void EnsureVisible(const wxTreeItemId& item);
+ virtual void EnsureVisible(const wxTreeItemId& item);
/**
Expands the given item.
*/
- void Expand(const wxTreeItemId& item);
+ virtual void Expand(const wxTreeItemId& item);
/**
Expands all items in the tree.
/**
Returns the number of items in the control.
*/
- unsigned int GetCount() const;
+ virtual unsigned int GetCount() const;
/**
Returns the edit control being currently used to edit a label. Returns
@note This is currently only implemented for wxMSW.
*/
- wxTextCtrl* GetEditControl() const;
+ virtual wxTextCtrl* GetEditControl() const;
/**
Returns the first child; call GetNextChild() for the next child.
/**
Returns the first visible item.
*/
- wxTreeItemId GetFirstVisibleItem() const;
+ virtual wxTreeItemId GetFirstVisibleItem() const;
/**
Returns the normal image list.
/**
Returns the background colour of the item.
*/
- wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
+ virtual wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
/**
Returns the tree item data associated with the item.
wxTreeItemData for the given item Id.
@endWxPythonOnly
*/
- wxTreeItemData* GetItemData(const wxTreeItemId& item) const;
+ virtual wxTreeItemData* GetItemData(const wxTreeItemId& item) const;
/**
Returns the font of the item label.
*/
- wxFont GetItemFont(const wxTreeItemId& item) const;
+ virtual wxFont GetItemFont(const wxTreeItemId& item) const;
/**
Gets the specified item image. The value of @a which may be:
/**
Returns the item's parent.
*/
- wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
/**
Gets the selected item image (this function is obsolete, use @ref
/**
Returns the item label.
*/
- wxString GetItemText(const wxTreeItemId& item) const;
+ virtual wxString GetItemText(const wxTreeItemId& item) const;
/**
Returns the colour of the item label.
*/
- wxColour GetItemTextColour(const wxTreeItemId& item) const;
+ virtual wxColour GetItemTextColour(const wxTreeItemId& item) const;
/**
Returns the last child of the item (or an invalid tree item if this item
@see GetFirstChild(), GetNextSibling(), GetLastChild()
*/
- wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
/**
Returns the next child; call GetFirstChild() for the first child. For
@see GetPrevSibling()
*/
- wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
/**
Returns the next visible item or an invalid item if this item is the
@note The @a item itself must be visible.
*/
- wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
/**
Returns the previous sibling of the specified item; call
@see GetNextSibling()
*/
- wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
/**
Returns the previous visible item or an invalid item if this item is the
@note The @a item itself must be visible.
*/
- wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
/**
Returns @true if the control will use a quick calculation for the best
/**
Returns the root item for the tree control.
*/
- wxTreeItemId GetRootItem() const;
+ virtual wxTreeItemId GetRootItem() const;
/**
Returns the selection, or an invalid item if there is no selection. This
function only works with the controls without @c wxTR_MULTIPLE style,
use GetSelections() for the controls which do have this style.
*/
- wxTreeItemId GetSelection() const;
+ virtual wxTreeItemId GetSelection() const;
/**
Fills the array of tree items passed in with the currently selected
@see SetItemBold()
*/
- bool IsBold(const wxTreeItemId& item) const;
+ virtual bool IsBold(const wxTreeItemId& item) const;
/**
Returns @true if the control is empty (i.e. has no items, even no root
Returns @true if the item is expanded (only makes sense if it has
children).
*/
- bool IsExpanded(const wxTreeItemId& item) const;
+ virtual bool IsExpanded(const wxTreeItemId& item) const;
/**
Returns @true if the item is selected.
*/
- bool IsSelected(const wxTreeItemId& item) const;
+ virtual bool IsSelected(const wxTreeItemId& item) const;
/**
Returns @true if the item is visible on the screen.
*/
- bool IsVisible(const wxTreeItemId& item) const;
+ virtual bool IsVisible(const wxTreeItemId& item) const;
/**
Returns @true if the item has children.
*/
- bool ItemHasChildren(const wxTreeItemId& item) const;
+ virtual bool ItemHasChildren(const wxTreeItemId& item) const;
/**
Override this function in the derived class to change the sort order of
/**
Scrolls the specified item into view.
*/
- void ScrollTo(const wxTreeItemId& item);
+ virtual void ScrollTo(const wxTreeItemId& item);
/**
Selects the given item. In multiple selection controls, can be also used
to deselect a currently selected item if the value of @a select is
@false.
*/
- void SelectItem(const wxTreeItemId& item, bool select = true);
+ virtual void SelectItem(const wxTreeItemId& item, bool select = true);
/**
Sets the buttons image list (from which application-defined button
@see AssignImageList().
*/
- void SetImageList(wxImageList* imageList);
+ virtual void SetImageList(wxImageList* imageList);
/**
Sets the indentation for the tree control.
@see IsBold()
*/
- void SetItemBold(const wxTreeItemId& item, bool bold = true);
+ virtual void SetItemBold(const wxTreeItemId& item, bool bold = true);
/**
Sets the item client data.
@endWxPythonOnly
*/
- void SetItemData(const wxTreeItemId& item, wxTreeItemData* data);
+ virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData* data);
/**
@see SetItemBold()
*/
- void SetItemFont(const wxTreeItemId& item, const wxFont& font);
+ virtual void SetItemFont(const wxTreeItemId& item, const wxFont& font);
/**
Force appearance of the button next to the item. This is useful to
/**
Sets the item label.
*/
- void SetItemText(const wxTreeItemId& item, const wxString& text);
+ virtual void SetItemText(const wxTreeItemId& item, const wxString& text);
/**
Sets the colour of the item's text.
@see AssignStateImageList().
*/
- void SetStateImageList(wxImageList* imageList);
+ virtual void SetStateImageList(wxImageList* imageList);
/**
Sets the mode flags associated with the display of the tree control. The
@see wxTreeItemData, OnCompareItems()
*/
- void SortChildren(const wxTreeItemId& item);
+ virtual void SortChildren(const wxTreeItemId& item);
/**
Toggles the given item between collapsed and expanded states.
*/
- void Toggle(const wxTreeItemId& item);
+ virtual void Toggle(const wxTreeItemId& item);
/**
Toggles the given item between selected and unselected states. For
/**
Removes the selection from the currently selected item (if any).
*/
- void Unselect();
+ virtual void Unselect();
/**
This function either behaves the same as Unselect() if the control
doesn't have @c wxTR_MULTIPLE style, or removes the selection from all
items if it does have this style.
*/
- void UnselectAll();
+ virtual void UnselectAll();
/**
Unselects the given item. This works in multiselection controls only.
Also calls Flush().
*/
- ~wxTextOutputStream();
+ virtual ~wxTextOutputStream();
/**
Flushes the stream.
@param uri
String with escaped characters to convert.
*/
- wxString Unescape(const wxString& uri);
+ static wxString Unescape(const wxString& uri);
/**
Compares this URI to another URI, and returns @true if this URI equals
/**
Destroys the URL object.
*/
- ~wxURL();
+ virtual ~wxURL();
/**
Returns the last error. This error refers to the URL parsing or to the
/**
Destructor.
*/
- ~wxGenericValidator();
+ virtual ~wxGenericValidator();
/**
Clones the generic validator using the copy constructor.
/**
Destructor.
*/
- ~wxValidator();
+ virtual ~wxValidator();
/**
All validator classes must implement the Clone() function, which
This functions switches on or turns off the error sound produced by the
validators if an invalid key is pressed.
*/
- void SetBellOnError(bool doIt = true);
+ static void SetBellOnError(bool doIt = true);
/**
Associates a window with the validator.
/**
Returns a reference to the exclude list (the list of invalid values).
*/
- wxArrayString& GetExcludes() const;
+ wxArrayString& GetExcludes();
/**
Returns a reference to the include list (the list of valid values).
*/
- wxArrayString& GetIncludes() const;
+ wxArrayString& GetIncludes();
/**
Returns the validator style.
called. See @ref overview_refcount_destruct
"reference-counted object destruction" for more info.
*/
- ~wxVariant();
+ virtual ~wxVariant();
/**
this function in order for wxVariant::Unshare() to work for your data.
This function is implemented for all built-in data types.
*/
- wxVariantData* Clone() const;
+ virtual wxVariantData* Clone() const;
/**
Decreases reference count. If the count reaches zero, the object is
If the data is a wxObject returns a pointer to the objects wxClassInfo
structure, if the data isn't a wxObject the method returns @NULL.
*/
- wxClassInfo* GetValueClassInfo() const;
+ virtual wxClassInfo* GetValueClassInfo();
/**
Increases reference count. Note that initially wxVariantData has
/**
Reads the data from @a string.
*/
- bool Read(wxString& string);
+ virtual bool Read(wxString& string);
/**
Writes the data to @a stream.
*/
- bool Write(ostream& stream) const;
+ virtual bool Write(ostream& stream) const;
/**
Writes the data to @a string.
*/
- bool Write(wxString& string) const;
+ virtual bool Write(wxString& string) const;
};
This is just a synonym for wxVScrolledWindow::SetRowCount().
*/
- void SetItemCount(size_t count);
+ virtual void SetItemCount(size_t count);
//@{
/**
@see SetTargetWindow()
*/
- wxWindow* GetTargetWindow() const;
+ virtual wxWindow* GetTargetWindow() const;
/**
Returns the index of the first visible unit based on the scroll
@see GetTargetWindow()
*/
- void SetTargetWindow(wxWindow* target);
+ virtual void SetTargetWindow(wxWindow* target);
/**
Update the thumb size shown by the scrollbar.
either the old file couldn't be deleted or that the new file couldn't be renamed
to the old name.
*/
- bool Commit();
+ virtual bool Commit();
/**
Discard changes: the old file contents are not changed, the temporary file is
deleted.
*/
- void Discard();
+ virtual void Discard();
};
/**
Destructor.
*/
- ~wxFFileOutputStream();
+ virtual ~wxFFileOutputStream();
/**
Returns @true if the stream is initialized and ready.
/**
Destructor.
*/
- ~wxFileOutputStream();
+ virtual ~wxFileOutputStream();
/**
Returns @true if the stream is initialized and ready.
/**
Destructor.
*/
- ~wxFileInputStream();
+ virtual ~wxFileInputStream();
/**
Returns @true if the stream is initialized and ready.
/**
Destructor.
*/
- ~wxFFileInputStream();
+ virtual ~wxFFileInputStream();
/**
Returns @true if the stream is initialized and ready.
@see @ref overview_windowdeletion "Window Deletion Overview",
Destroy(), wxCloseEvent
*/
- ~wxWindow();
+ virtual ~wxWindow();
/**
This method may be overridden in the derived classes to return @false to
SetTransparent() may succeed. If this function returns @false, transparent
windows are definitely not supported by the current system.
*/
- bool CanSetTransparent();
+ virtual bool CanSetTransparent();
/**
Directs all mouse input to this window.
@see ReleaseMouse(), wxMouseCaptureLostEvent
*/
- virtual void CaptureMouse();
+ void CaptureMouse();
/**
A synonym for Centre().
Clears the window by filling it with the current background colour. Does not
cause an erase background event to be generated.
*/
- void ClearBackground();
+ virtual void ClearBackground();
/**
Converts to screen coordinates from coordinates relative to this window.
@see WindowToClientSize()
*/
- virtual wxSize ClientToWindowSize(const wxSize& size);
+ virtual wxSize ClientToWindowSize(const wxSize& size) const;
/**
Converts window size @a size to corresponding client area size
@see ClientToWindowSize()
*/
- virtual wxSize WindowToClientSize(const wxSize& size);
+ virtual wxSize WindowToClientSize(const wxSize& size) const;
/**
This function simply generates a wxCloseEvent whose handler usually tries
@see wxWindowUpdateLocker, Thaw(), IsFrozen()
*/
- virtual void Freeze();
+ void Freeze();
/**
Gets the accelerator table for this window. See wxAcceleratorTable.
*/
- wxAcceleratorTable* GetAcceleratorTable() const;
+ wxAcceleratorTable* GetAcceleratorTable();
/**
Returns the accessible object for this window, if any.
@see SetDropTarget(), @ref overview_dnd
*/
- wxDropTarget* GetDropTarget() const;
+ virtual wxDropTarget* GetDropTarget() const;
/**
Merges the window's best size into the min size and returns the result.
@see SetForegroundColour(), SetBackgroundColour(),
GetBackgroundColour()
*/
- wxColour GetForegroundColour();
+ wxColour GetForegroundColour() const;
/**
Returns the grandparent of a window, or @NULL if there isn't one.
@see SetHelpText(), GetHelpTextAtPoint(), wxHelpProvider
*/
- virtual wxString GetHelpText() const;
+ wxString GetHelpText() const;
/**
Gets the help text to be used as context-sensitive help for this window.
@see GetMaxSize()
*/
- wxSize GetMaxClientSize() const;
+ virtual wxSize GetMaxClientSize() const;
/**
Returns the maximum size of the window.
@see GetMaxClientSize()
*/
- wxSize GetMaxSize() const;
+ virtual wxSize GetMaxSize() const;
/**
Returns the minimum size of window's client area, an indication to the sizer
/**
Returns the parent of the window, or @NULL if there is no parent.
*/
- virtual wxWindow* GetParent() const;
+ wxWindow* GetParent() const;
/**
This function shows a popup menu at the given position in this window and
@see See SetScrollbar()
*/
- virtual int GetScrollPos(int orientation);
+ virtual int GetScrollPos(int orientation) const;
/**
Returns the built-in scrollbar range.
@see SetScrollbar()
*/
- virtual int GetScrollRange(int orientation);
+ virtual int GetScrollRange(int orientation) const;
/**
Returns the built-in scrollbar thumb size.
@see SetScrollbar()
*/
- virtual int GetScrollThumb(int orientation);
+ virtual int GetScrollThumb(int orientation) const;
/**
Returns the size of the entire window in pixels, including title bar, border,
Returns a pointer to the current validator for the window, or @NULL if
there is none.
*/
- wxValidator* GetValidator() const;
+ virtual wxValidator* GetValidator();
//@{
/**
Returns the size of the left/right and top/bottom borders of this window in x
and y components of the result respectively.
*/
- wxSize GetWindowBorderSize() const;
+ virtual wxSize GetWindowBorderSize() const;
/**
Gets the window style that was passed to the constructor or @b Create
method. @b GetWindowStyle() is another name for the same function.
*/
- long GetWindowStyleFlag() const;
+ virtual long GetWindowStyleFlag() const;
/**
Returns the value previously passed to SetWindowVariant().
GetEventHandler()->SafelyProcessEvent(event);
@endcode
*/
- bool HandleWindowEvent(wxEvent& event);
+ bool HandleWindowEvent(wxEvent& event) const;
/**
Returns @true if this window has the current mouse capture.
@param orient
Orientation to check, either wxHORIZONTAL or wxVERTICAL.
*/
- virtual bool HasScrollbar(int orient) const;
+ bool HasScrollbar(int orient) const;
/**
Returns @true if this window background is transparent (as, for example,
shouldn't have to call it. You may, however, have to override it in your
wxWindow-derived class to ensure that background is painted correctly.
*/
- virtual bool HasTransparentBackground() const;
+ virtual bool HasTransparentBackground();
/**
Equivalent to calling wxWindow::Show(@false).
just changing the font or colour of their common parent, hence in this case we
do inherit the parents attributes.
*/
- void InheritAttributes();
+ virtual void InheritAttributes();
/**
Sends an @c wxEVT_INIT_DIALOG event, whose handler usually transfers data
to the dialog via validators.
*/
- void InitDialog();
+ virtual void InitDialog();
/**
Resets the cached best size value so it will be recalculated the next time it
@see Enable()
*/
- virtual bool IsEnabled() const;
+ bool IsEnabled() const;
//@{
/**
@see Freeze(), Thaw()
*/
- virtual bool IsFrozen() const;
+ bool IsFrozen() const;
/**
Returns @true if the window is retained, @false otherwise.
@see AlwaysShowScrollbars()
*/
- bool IsScrollbarAlwaysShown(int orient);
+ virtual bool IsScrollbarAlwaysShown(int orient) const;
/**
Returns @true if the window is shown, @false if it has been hidden.
dialogs are considered to be top-level windows (even if they have a parent
window).
*/
- bool IsTopLevel() const;
+ virtual bool IsTopLevel() const;
/**
Invokes the constraint-based layout algorithm or the sizer-based algorithm
@see Raise()
*/
- void Lower();
+ virtual void Lower();
/**
Disables all other windows in the application so that
@see SetEventHandler(), GetEventHandler(),
PushEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler
*/
- wxEvtHandler* PopEventHandler(bool deleteHandler = false) const;
+ wxEvtHandler* PopEventHandler(bool deleteHandler = false);
//@{
/**
@see Lower()
*/
- void Raise();
+ virtual void Raise();
/**
Causes this window, and all of its children recursively (except under wxGTK1
@see CaptureMouse(), HasCapture(), ReleaseMouse(),
wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent
*/
- virtual void ReleaseMouse();
+ void ReleaseMouse();
/**
Removes a child window.
@param flags
May include @c wxSEND_EVENT_POST. Default value is 0.
*/
- void SendSizeEvent(int flags = 0);
+ virtual void SendSizeEvent(int flags = 0);
/**
Safe wrapper for GetParent()->SendSizeEvent().
/**
Sets the caret() associated with the window.
*/
- void SetCaret(wxCaret* caret) const;
+ void SetCaret(wxCaret* caret);
//@{
/**
@see GetDropTarget(), @ref overview_dnd
*/
- void SetDropTarget(wxDropTarget* target);
+ virtual void SetDropTarget(wxDropTarget* target);
/**
Sets the event handler for this window.
The currently defined extra style bits are reported in the class
description.
*/
- void SetExtraStyle(long exStyle);
+ virtual void SetExtraStyle(long exStyle);
/**
This sets the window to receive keyboard input.
@see GetFont(), InheritAttributes()
*/
- bool SetFont(const wxFont& font);
+ virtual bool SetFont(const wxFont& font);
/**
Sets the foreground colour of the window.
@see GetHelpText(), wxHelpProvider::AddHelp()
*/
- virtual void SetHelpText(const wxString& helpText);
+ void SetHelpText(const wxString& helpText);
/**
Sets the identifier of the window.
@see SetMaxSize()
*/
- void SetMaxClientSize(const wxSize& size);
+ virtual void SetMaxClientSize(const wxSize& size);
/**
Sets the maximum size of the window, to indicate to the sizer layout mechanism
@see SetMaxClientSize()
*/
- void SetMaxSize(const wxSize& size);
+ virtual void SetMaxSize(const wxSize& size);
/**
Sets the minimum client size of the window, to indicate to the sizer
@see SetMinSize()
*/
- void SetMinClientSize(const wxSize& size);
+ virtual void SetMinClientSize(const wxSize& size);
/**
Sets the minimum size of the window, to indicate to the sizer layout
@see SetMinClientSize()
*/
- void SetMinSize(const wxSize& size);
+ virtual void SetMinSize(const wxSize& size);
/**
Sets the window's name.
fully transparent window and 255 to the fully opaque one. The constants
@c wxIMAGE_ALPHA_TRANSPARENT and @c wxIMAGE_ALPHA_OPAQUE can be used.
*/
- bool SetTransparent(wxByte alpha);
+ virtual bool SetTransparent(wxByte alpha);
/**
Deletes the current validator (if any) and sets the window validator, having
The base class version returns @false, but this method is overridden in
wxControl where it returns @true.
*/
- virtual bool ShouldInheritColours();
+ virtual bool ShouldInheritColours() const;
/**
Shows or hides the window. You may need to call Raise()
@see wxWindowUpdateLocker, Freeze(), IsFrozen()
*/
- virtual void Thaw();
+ void Thaw();
/**
Turns the given @a flag on if it's currently turned off and vice versa.
@param y
The new y position for the cursor.
*/
- void WarpPointer(int x, int y);
+ virtual void WarpPointer(int x, int y);
};
The only cases when you would want to override this function is if the page
bitmap depends dynamically on the user choices, i.e. almost never.
*/
- wxBitmap GetBitmap() const;
+ virtual wxBitmap GetBitmap() const;
/**
Get the page which should be shown when the user chooses the @c "Next"
run-time, as in this case, the wizard won't be able to get to all pages starting
from a single one and you should call @e Fit separately for the others.
*/
- void FitToPage(const wxWizardPage* firstPage);
+ virtual void FitToPage(const wxWizardPage* firstPage);
/**
Returns the bitmap used for the wizard.
See also SetBitmapPlacement() for the possible values.
*/
- int GetBitmapPlacement();
+ int GetBitmapPlacement() const;
/**
Get the current page while the wizard is running.
@NULL is returned if RunWizard() is not being executed now.
*/
- wxWizardPage* GetCurrentPage() const;
+ virtual wxWizardPage* GetCurrentPage() const;
/**
Returns the minimum width for the bitmap that will be constructed to contain
/**
Returns the size available for the pages.
*/
- wxSize GetPageSize() const;
+ virtual wxSize GetPageSize() const;
/**
Return @true if this page is not the last one in the wizard.
successfully finished or @false if user cancelled it.
The @a firstPage can not be @NULL.
*/
- bool RunWizard(wxWizardPage* firstPage);
+ virtual bool RunWizard(wxWizardPage* firstPage);
/**
Sets the bitmap used for the wizard.
will be added to the control border in order to space page controls ten points
from the dialog border and non-page controls.
*/
- void SetBorder(int border);
+ virtual void SetBorder(int border);
/**
Sets the minimum width for the bitmap that will be constructed to contain the
@deprecated
This method is obsolete, use GetPageAreaSizer() instead.
*/
- void SetPageSize(const wxSize& sizePage);
+ virtual void SetPageSize(const wxSize& sizePage);
};
/**
The virtual destructor. Deletes attached children and attributes.
*/
- ~wxXmlNode();
+ virtual ~wxXmlNode();
/**
Appends a attribute with given @a name and @a value to the list of
attributes for this node.
*/
- void AddAttribute(const wxString& name, const wxString& value);
+ virtual void AddAttribute(const wxString& name, const wxString& value);
/**
Appends given attribute to the list of attributes for this node.
*/
- void AddAttribute(wxXmlAttribute* attr);
+ virtual void AddAttribute(wxXmlAttribute* attr);
/**
Adds node @a child as the last child of this node.
@see InsertChild(), InsertChildAfter()
*/
- void AddChild(wxXmlNode* child);
+ virtual void AddChild(wxXmlNode* child);
/**
Removes the first attributes which has the given @a name from the list of
attributes for this node.
*/
- bool DeleteAttribute(const wxString& name);
+ virtual bool DeleteAttribute(const wxString& name);
/**
Returns true if a attribute named attrName could be found.
@see AddChild(), InsertChildAfter()
*/
- bool InsertChild(wxXmlNode* child, wxXmlNode* followingNode);
+ virtual bool InsertChild(wxXmlNode* child, wxXmlNode* followingNode);
/**
Inserts the @a child node immediately after @a precedingNode in the
@see InsertChild(), AddChild()
*/
- bool InsertChildAfter(wxXmlNode* child, wxXmlNode* precedingNode);
+ virtual bool InsertChildAfter(wxXmlNode* child, wxXmlNode* precedingNode);
/**
Returns @true if the content of this node is a string containing only
Note that the caller is reponsible for deleting the removed node in order
to avoid memory leaks.
*/
- bool RemoveChild(wxXmlNode* child);
+ virtual bool RemoveChild(wxXmlNode* child);
/**
Sets as first attribute the given wxXmlAttribute object.
/**
The virtual destructor.
*/
- ~wxXmlAttribute();
+ virtual ~wxXmlAttribute();
/**
Returns the name of this attribute.
/**
Virtual destructor. Frees the document root node.
*/
- ~wxXmlDocument();
+ virtual ~wxXmlDocument();
/**
Detaches the document root node and returns it.
/**
Destructor.
*/
- ~wxXmlResource();
+ virtual ~wxXmlResource();
/**
Initializes only a specific handler (or custom handler). Convention says
/**
Gets the global resources object or creates one if none exists.
*/
- wxXmlResource* Get();
+ static wxXmlResource* Get();
/**
Returns the domain (message catalog) that will be used to load
Returns flags, which may be a bitlist of wxXRC_USE_LOCALE and
wxXRC_NO_SUBCLASSING.
*/
- int GetFlags();
+ int GetFlags() const;
/**
Returns version information (a.b.c.d = d+ 256*c + 256@c 2*b + 256@c 3*a).
Sets the global resources object and returns a pointer to the previous one (may
be @NULL).
*/
- wxXmlResource* Set(wxXmlResource* res);
+ static wxXmlResource* Set(wxXmlResource* res);
/**
Sets the domain (message catalog) that will be used to load
/**
Destructor.
*/
- ~wxXmlResourceHandler();
+ virtual ~wxXmlResourceHandler();
/**
Add a style flag (e.g. wxMB_DOCKABLE) to the list of flags
The destructor calls Close() to finish writing the zip if it has
not been called already.
*/
- ~wxZipOutputStream();
+ virtual ~wxZipOutputStream();
/**
Finishes writing the zip, returning @true if successful.
projects / wxWidgets.git / commitdiff
