prototype fixes (this time including pure virtual function detection)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52771 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-24 22:17:25 +00:00
parent f270e1ddda
commit d2aa927a57
12 changed files with 115 additions and 111 deletions

View File

@@ -10,14 +10,18 @@
@class wxAppTraits @class wxAppTraits
@wxheader{apptrait.h} @wxheader{apptrait.h}
The @b wxAppTraits class defines various configurable aspects of a wxApp. The wxAppTraits class defines various configurable aspects of a wxApp.
You can access it using wxApp::GetTraits function and you can create your You can access it using wxApp::GetTraits() function and you can create your
own wxAppTraits overriding the wxApp::CreateTraits function. own wxAppTraits overriding the wxApp::CreateTraits() function.
By default, wxWidgets creates a @c wxConsoleAppTraits object for console Note that wxAppTraits is an abstract class since it contains many
applications (i.e. those applications linked against wxBase library only - pure virtual functions.
see the @ref page_libs page) and a @c wxGUIAppTraits object for GUI In fact, by default, wxWidgets creates a @c wxConsoleAppTraits object for
console applications (i.e. those applications linked against wxBase library
only - see the @ref page_libs page) and a @c wxGUIAppTraits object for GUI
applications. applications.
Both these classes are derived by wxAppTraits and represent concrete
implementation of the wxAppTraits interface.
@library{wxbase} @library{wxbase}
@category{appmanagement} @category{appmanagement}
@@ -40,7 +44,7 @@ public:
/** /**
Creates the global font mapper object used for encodings/charset mapping. Creates the global font mapper object used for encodings/charset mapping.
*/ */
virtual wxFontMapper* CreateFontMapper(); virtual wxFontMapper* CreateFontMapper() = 0;
/** /**
Creates a wxLog class for the application to use for logging errors. Creates a wxLog class for the application to use for logging errors.
@@ -48,12 +52,12 @@ public:
@see wxLog @see wxLog
*/ */
virtual wxLog* CreateLogTarget(); virtual wxLog* CreateLogTarget() = 0;
/** /**
Creates the global object used for printing out messages. Creates the global object used for printing out messages.
*/ */
virtual wxMessageOutput* CreateMessageOutput(); virtual wxMessageOutput* CreateMessageOutput() = 0;
/** /**
Returns the renderer to use for drawing the generic controls (return Returns the renderer to use for drawing the generic controls (return
@@ -63,7 +67,7 @@ public:
@note the returned pointer needs to be deleted by the caller. @note the returned pointer needs to be deleted by the caller.
*/ */
virtual wxRendererNative* CreateRenderer(); virtual wxRendererNative* CreateRenderer() = 0;
/** /**
This method returns the name of the desktop environment currently This method returns the name of the desktop environment currently
@@ -72,7 +76,7 @@ public:
to figure out, which desktop environment is running. The method to figure out, which desktop environment is running. The method
returns an empty string otherwise and on all other platforms. returns an empty string otherwise and on all other platforms.
*/ */
virtual wxString GetDesktopEnvironment() const; virtual wxString GetDesktopEnvironment() const = 0;
/** /**
Returns the wxStandardPaths object for the application. Returns the wxStandardPaths object for the application.
@@ -98,24 +102,24 @@ public:
and put in given pointers the versions of the GTK library in use. and put in given pointers the versions of the GTK library in use.
See wxPlatformInfo for more details. See wxPlatformInfo for more details.
*/ */
virtual wxPortId GetToolkitVersion(int* major = NULL, int* minor = NULL) const; virtual wxPortId GetToolkitVersion(int* major = NULL, int* minor = NULL) const = 0;
/** /**
Returns @true if @c fprintf(stderr) goes somewhere, @false otherwise. Returns @true if @c fprintf(stderr) goes somewhere, @false otherwise.
*/ */
virtual bool HasStderr(); virtual bool HasStderr() = 0;
/** /**
Returns @true if the library was built as wxUniversal. Returns @true if the library was built as wxUniversal.
Always returns @false for wxBase-only apps. Always returns @false for wxBase-only apps.
*/ */
virtual bool IsUsingUniversalWidgets() const; virtual bool IsUsingUniversalWidgets() const = 0;
/** /**
Shows the assert dialog with the specified message in GUI mode or just prints Shows the assert dialog with the specified message in GUI mode or just prints
the string to stderr in console mode. the string to stderr in console mode.
Returns @true to suppress subsequent asserts, @false to continue as before. Returns @true to suppress subsequent asserts, @false to continue as before.
*/ */
virtual bool ShowAssertDialog(const wxString& msg); virtual bool ShowAssertDialog(const wxString& msg) = 0;
}; };

View File

@@ -10,7 +10,7 @@
@class wxArchiveInputStream @class wxArchiveInputStream
@wxheader{archive.h} @wxheader{archive.h}
An abstract base class which serves as a common interface to This is an abstract base class which serves as a common interface to
archive input streams such as wxZipInputStream. archive input streams such as wxZipInputStream.
wxArchiveInputStream::GetNextEntry returns an wxArchiveEntry object containing wxArchiveInputStream::GetNextEntry returns an wxArchiveEntry object containing
@@ -34,7 +34,7 @@ public:
Closes the current entry. On a non-seekable stream reads to the end of Closes the current entry. On a non-seekable stream reads to the end of
the current entry first. the current entry first.
*/ */
virtual bool CloseEntry(); virtual bool CloseEntry() = 0;
/** /**
Closes the current entry if one is open, then reads the meta-data for Closes the current entry if one is open, then reads the meta-data for
@@ -50,7 +50,7 @@ public:
@a entry must be from the same archive file that this wxArchiveInputStream @a entry must be from the same archive file that this wxArchiveInputStream
is reading, and it must be reading it from a seekable stream. is reading, and it must be reading it from a seekable stream.
*/ */
virtual bool OpenEntry(wxArchiveEntry& entry); virtual bool OpenEntry(wxArchiveEntry& entry) = 0;
}; };
@@ -59,7 +59,7 @@ public:
@class wxArchiveOutputStream @class wxArchiveOutputStream
@wxheader{archive.h} @wxheader{archive.h}
An abstract base class which serves as a common interface to This is an abstract base class which serves as a common interface to
archive output streams such as wxZipOutputStream. archive output streams such as wxZipOutputStream.
wxArchiveOutputStream::PutNextEntry is used to create a new entry in the wxArchiveOutputStream::PutNextEntry is used to create a new entry in the
@@ -92,7 +92,7 @@ public:
It is called implicitly whenever another new entry is created with CopyEntry() It is called implicitly whenever another new entry is created with CopyEntry()
or PutNextEntry(), or when the archive is closed. or PutNextEntry(), or when the archive is closed.
*/ */
virtual bool CloseEntry(); virtual bool CloseEntry() = 0;
/** /**
Some archive formats have additional meta-data that applies to the archive Some archive formats have additional meta-data that applies to the archive
@@ -111,7 +111,7 @@ public:
in which case the two streams set up a link and transfer the data in which case the two streams set up a link and transfer the data
when it becomes available. when it becomes available.
*/ */
virtual bool CopyArchiveMetaData(wxArchiveInputStream& stream); virtual bool CopyArchiveMetaData(wxArchiveInputStream& stream) = 0;
/** /**
Takes ownership of @a entry and uses it to create a new entry in the Takes ownership of @a entry and uses it to create a new entry in the
@@ -160,7 +160,7 @@ public:
@class wxArchiveEntry @class wxArchiveEntry
@wxheader{archive.h} @wxheader{archive.h}
An abstract base class which serves as a common interface to This is an abstract base class which serves as a common interface to
archive entry classes such as wxZipEntry. archive entry classes such as wxZipEntry.
These hold the meta-data (filename, timestamp, etc.), for entries These hold the meta-data (filename, timestamp, etc.), for entries
in archive files such as zips and tars. in archive files such as zips and tars.
@@ -196,12 +196,12 @@ public:
/** /**
Gets the entry's timestamp. Gets the entry's timestamp.
*/ */
virtual wxDateTime GetDateTime() const; virtual wxDateTime GetDateTime() const = 0;
/** /**
Sets the entry's timestamp. Sets the entry's timestamp.
*/ */
virtual void SetDateTime(const wxDateTime& dt); virtual void SetDateTime(const wxDateTime& dt) = 0;
/** /**
Returns the entry's name, by default in the native format. Returns the entry's name, by default in the native format.
@@ -210,7 +210,7 @@ public:
If this is a directory entry, (i.e. if IsDir() is @true) then the If this is a directory entry, (i.e. if IsDir() is @true) then the
returned string is the name with a trailing path separator. returned string is the name with a trailing path separator.
*/ */
virtual wxString GetName(wxPathFormat format = wxPATH_NATIVE) const; virtual wxString GetName(wxPathFormat format = wxPATH_NATIVE) const = 0;
/** /**
Sets the entry's name. Sets the entry's name.
@@ -224,18 +224,18 @@ public:
/** /**
Returns the size of the entry's data in bytes. Returns the size of the entry's data in bytes.
*/ */
virtual wxFileOffset GetSize() const; virtual wxFileOffset GetSize() const = 0;
/** /**
Sets the size of the entry's data in bytes. Sets the size of the entry's data in bytes.
*/ */
virtual void SetSize(wxFileOffset size); virtual void SetSize(wxFileOffset size) = 0;
/** /**
Returns the path format used internally within the archive to store Returns the path format used internally within the archive to store
filenames. filenames.
*/ */
virtual wxPathFormat GetInternalFormat() const; virtual wxPathFormat GetInternalFormat() const = 0;
/** /**
Returns the entry's filename in the internal format used within the Returns the entry's filename in the internal format used within the
@@ -247,12 +247,12 @@ public:
@see @ref overview_archive_byname @see @ref overview_archive_byname
*/ */
virtual wxString GetInternalName() const; virtual wxString GetInternalName() const = 0;
/** /**
Returns a numeric value unique to the entry within the archive. Returns a numeric value unique to the entry within the archive.
*/ */
virtual wxFileOffset GetOffset() const; virtual wxFileOffset GetOffset() const = 0;
/** /**
Returns @true if this is a directory entry. Returns @true if this is a directory entry.
@@ -266,22 +266,22 @@ public:
unarchivers typically create whatever directories are necessary as they unarchivers typically create whatever directories are necessary as they
restore files, even if the archive contains no explicit directory entries. restore files, even if the archive contains no explicit directory entries.
*/ */
virtual bool IsDir() const; virtual bool IsDir() const = 0;
/** /**
Marks this entry as a directory if @a isDir is @true. See IsDir() for more info. Marks this entry as a directory if @a isDir is @true. See IsDir() for more info.
*/ */
virtual void SetIsDir(bool isDir = true); virtual void SetIsDir(bool isDir = true) = 0;
/** /**
Returns @true if the entry is a read-only file. Returns @true if the entry is a read-only file.
*/ */
virtual bool IsReadOnly() const; virtual bool IsReadOnly() const = 0;
/** /**
Sets this entry as a read-only file. Sets this entry as a read-only file.
*/ */
virtual void SetIsReadOnly(bool isReadOnly = true); virtual void SetIsReadOnly(bool isReadOnly = true) = 0;
/** /**
Sets the notifier (see wxArchiveNotifier) for this entry. Sets the notifier (see wxArchiveNotifier) for this entry.

View File

@@ -170,7 +170,7 @@ public:
Sets the font for drawing the tab labels, using a bold version of the font for Sets the font for drawing the tab labels, using a bold version of the font for
selected tab labels. selected tab labels.
*/ */
bool SetFont(const wxFont& font); virtual bool SetFont(const wxFont& font);
/** /**
Sets the font for measuring tab labels. Sets the font for measuring tab labels.
@@ -213,7 +213,7 @@ public:
Specifying -1 as the height will return the control to its default auto-sizing Specifying -1 as the height will return the control to its default auto-sizing
behaviour. behaviour.
*/ */
void SetTabCtrlHeight(int height); virtual void SetTabCtrlHeight(int height);
//@{ //@{
/** /**
@@ -259,12 +259,12 @@ public:
/** /**
Clones the art object. Clones the art object.
*/ */
wxAuiTabArt* Clone(); virtual wxAuiTabArt* Clone() = 0;
/** /**
Draws a background on the given area. Draws a background on the given area.
*/ */
void DrawBackground(wxDC& dc, wxWindow* wnd, const wxRect& rect); virtual void DrawBackground(wxDC& dc, wxWindow* wnd, const wxRect& rect) = 0;
/** /**
Draws a button. Draws a button.
@@ -297,7 +297,7 @@ public:
/** /**
Returns the indent size. Returns the indent size.
*/ */
int GetIndentSize(); virtual int GetIndentSize() = 0;
/** /**
Returns the tab size for the given caption, bitmap and state. Returns the tab size for the given caption, bitmap and state.
@@ -312,27 +312,27 @@ public:
/** /**
Sets flags. Sets flags.
*/ */
void SetFlags(unsigned int flags); virtual void SetFlags(unsigned int flags) = 0;
/** /**
Sets the font used for calculating measurements. Sets the font used for calculating measurements.
*/ */
void SetMeasuringFont(const wxFont& font); virtual void SetMeasuringFont(const wxFont& font) = 0;
/** /**
Sets the normal font for drawing labels. Sets the normal font for drawing labels.
*/ */
void SetNormalFont(const wxFont& font); virtual void SetNormalFont(const wxFont& font) = 0;
/** /**
Sets the font for drawing text for selected UI elements. Sets the font for drawing text for selected UI elements.
*/ */
void SetSelectedFont(const wxFont& font); virtual void SetSelectedFont(const wxFont& font) = 0;
/** /**
Sets sizing information. Sets sizing information.
*/ */
void SetSizingInfo(const wxSize& tab_ctrl_size, size_t tab_count); virtual void SetSizingInfo(const wxSize& tab_ctrl_size, size_t tab_count) = 0;
/** /**
Pops up a menu to show the list of windows managed by wxAui. Pops up a menu to show the list of windows managed by wxAui.

View File

@@ -160,29 +160,29 @@ public:
/** /**
Get a font setting. Get a font setting.
*/ */
virtual wxFont GetFont(int id); virtual wxFont GetFont(int id) = 0;
/** /**
Get the value of a certain setting. Get the value of a certain setting.
@a id can be one of the size values of @b wxAuiPaneDockArtSetting. @a id can be one of the size values of @b wxAuiPaneDockArtSetting.
*/ */
virtual int GetMetric(int id); virtual int GetMetric(int id) = 0;
/** /**
Set a certain setting with the value @e colour. Set a certain setting with the value @e colour.
@a id can be one of the colour values of @b wxAuiPaneDockArtSetting. @a id can be one of the colour values of @b wxAuiPaneDockArtSetting.
*/ */
virtual void SetColour(int id, const wxColor& colour) = 0; virtual void SetColour(int id, const wxColour& colour) = 0;
/** /**
Set a font setting. Set a font setting.
*/ */
virtual void SetFont(int id, const wxFont& font); virtual void SetFont(int id, const wxFont& font) = 0;
/** /**
Set a certain setting with the value @e new_val. Set a certain setting with the value @e new_val.
@a id can be one of the size values of @b wxAuiPaneDockArtSetting. @a id can be one of the size values of @b wxAuiPaneDockArtSetting.
*/ */
virtual void SetMetric(int id, int new_val); virtual void SetMetric(int id, int new_val) = 0;
}; };

View File

@@ -157,7 +157,7 @@ public:
/** /**
Returns an array of all panes managed by the frame manager. Returns an array of all panes managed by the frame manager.
*/ */
wxAuiPaneInfoArray GetAllPanes(); wxAuiPaneInfoArray& GetAllPanes();
/** /**
Returns the current art provider being used. Returns the current art provider being used.
@@ -169,7 +169,7 @@ public:
Returns the current dock constraint values. Returns the current dock constraint values.
See SetDockSizeConstraint() for more information. See SetDockSizeConstraint() for more information.
*/ */
void GetDockSizeConstraint(double* widthpct, double* heightpct); void GetDockSizeConstraint(double* widthpct, double* heightpct) const;
/** /**
Returns the current manager's flags. Returns the current manager's flags.
@@ -210,7 +210,7 @@ public:
/** /**
HideHint() hides any docking hint that may be visible. HideHint() hides any docking hint that may be visible.
*/ */
void HideHint(); virtual void HideHint();
/** /**
This method is used to insert either a previously unmanaged pane window This method is used to insert either a previously unmanaged pane window
@@ -307,7 +307,7 @@ public:
implementing custom pane drag/drop behaviour. implementing custom pane drag/drop behaviour.
The specified rectangle should be in screen coordinates. The specified rectangle should be in screen coordinates.
*/ */
void ShowHint(const wxRect& rect); virtual void ShowHint(const wxRect& rect);
/** /**
Uninitializes the framework and should be called before a managed frame or Uninitializes the framework and should be called before a managed frame or
@@ -373,24 +373,24 @@ public:
Bottom() sets the pane dock position to the bottom side of the frame. This is Bottom() sets the pane dock position to the bottom side of the frame. This is
the same thing as calling Direction(wxAUI_DOCK_BOTTOM). the same thing as calling Direction(wxAUI_DOCK_BOTTOM).
*/ */
wxAuiPaneInfo Bottom(); wxAuiPaneInfo& Bottom();
/** /**
BottomDockable() indicates whether a pane can be docked at the bottom of the BottomDockable() indicates whether a pane can be docked at the bottom of the
frame. frame.
*/ */
wxAuiPaneInfo BottomDockable(bool b = true); wxAuiPaneInfo& BottomDockable(bool b = true);
/** /**
Caption() sets the caption of the pane. Caption() sets the caption of the pane.
*/ */
wxAuiPaneInfo Caption(const wxString& c); wxAuiPaneInfo& Caption(const wxString& c);
/** /**
CaptionVisible indicates that a pane caption should be visible. If @false, no CaptionVisible indicates that a pane caption should be visible. If @false, no
pane caption is drawn. pane caption is drawn.
*/ */
wxAuiPaneInfo CaptionVisible(bool visible = true); wxAuiPaneInfo& CaptionVisible(bool visible = true);
//@{ //@{
/** /**
@@ -417,12 +417,12 @@ public:
/** /**
CloseButton() indicates that a close button should be drawn for the pane. CloseButton() indicates that a close button should be drawn for the pane.
*/ */
wxAuiPaneInfo CloseButton(bool visible = true); wxAuiPaneInfo& CloseButton(bool visible = true);
/** /**
DefaultPane() specifies that the pane should adopt the default pane settings. DefaultPane() specifies that the pane should adopt the default pane settings.
*/ */
wxAuiPaneInfo DefaultPane(); wxAuiPaneInfo& DefaultPane();
/** /**
DestroyOnClose() indicates whether a pane should be detroyed when it is closed. DestroyOnClose() indicates whether a pane should be detroyed when it is closed.
@@ -430,49 +430,49 @@ public:
Setting DestroyOnClose to @true will cause the window to be destroyed when Setting DestroyOnClose to @true will cause the window to be destroyed when
the user clicks the pane's close button. the user clicks the pane's close button.
*/ */
wxAuiPaneInfo DestroyOnClose(bool b = true); wxAuiPaneInfo& DestroyOnClose(bool b = true);
/** /**
Direction() determines the direction of the docked pane. It is functionally the Direction() determines the direction of the docked pane. It is functionally the
same as calling Left(), Right(), Top() or Bottom(), except that docking direction same as calling Left(), Right(), Top() or Bottom(), except that docking direction
may be specified programmatically via the parameter. may be specified programmatically via the parameter.
*/ */
wxAuiPaneInfo Direction(int direction); wxAuiPaneInfo& Direction(int direction);
/** /**
Dock() indicates that a pane should be docked. It is the opposite of Float(). Dock() indicates that a pane should be docked. It is the opposite of Float().
*/ */
wxAuiPaneInfo Dock(); wxAuiPaneInfo& Dock();
/** /**
DockFixed() causes the containing dock to have no resize sash. This is useful DockFixed() causes the containing dock to have no resize sash. This is useful
for creating panes that span the entire width or height of a dock, but should for creating panes that span the entire width or height of a dock, but should
not be resizable in the other direction. not be resizable in the other direction.
*/ */
wxAuiPaneInfo DockFixed(bool b = true); wxAuiPaneInfo& DockFixed(bool b = true);
/** /**
Dockable() specifies whether a frame can be docked or not. It is the same as Dockable() specifies whether a frame can be docked or not. It is the same as
specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b). specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b).
*/ */
wxAuiPaneInfo Dockable(bool b = true); wxAuiPaneInfo& Dockable(bool b = true);
/** /**
Fixed() forces a pane to be fixed size so that it cannot be resized. After Fixed() forces a pane to be fixed size so that it cannot be resized. After
calling Fixed(), IsFixed() will return @true. calling Fixed(), IsFixed() will return @true.
*/ */
wxAuiPaneInfo Fixed(); wxAuiPaneInfo& Fixed();
/** /**
Float() indicates that a pane should be floated. It is the opposite of Dock(). Float() indicates that a pane should be floated. It is the opposite of Dock().
*/ */
wxAuiPaneInfo Float(); wxAuiPaneInfo& Float();
/** /**
Floatable() sets whether the user will be able to undock a pane and turn it Floatable() sets whether the user will be able to undock a pane and turn it
into a floating window. into a floating window.
*/ */
wxAuiPaneInfo Floatable(bool b = true); wxAuiPaneInfo& Floatable(bool b = true);
//@{ //@{
/** /**
@@ -493,12 +493,12 @@ public:
/** /**
Gripper() indicates that a gripper should be drawn for the pane. Gripper() indicates that a gripper should be drawn for the pane.
*/ */
wxAuiPaneInfo Gripper(bool visible = true); wxAuiPaneInfo& Gripper(bool visible = true);
/** /**
GripperTop() indicates that a gripper should be drawn at the top of the pane. GripperTop() indicates that a gripper should be drawn at the top of the pane.
*/ */
wxAuiPaneInfo GripperTop(bool attop = true); wxAuiPaneInfo& GripperTop(bool attop = true);
/** /**
HasBorder() returns @true if the pane displays a border. HasBorder() returns @true if the pane displays a border.
@@ -551,7 +551,7 @@ public:
/** /**
Hide() indicates that a pane should be hidden. Hide() indicates that a pane should be hidden.
*/ */
wxAuiPaneInfo Hide(); wxAuiPaneInfo& Hide();
/** /**
IsBottomDockable() returns @true if the pane can be docked at the bottom of the IsBottomDockable() returns @true if the pane can be docked at the bottom of the
@@ -631,18 +631,18 @@ public:
direction has a higher layer number. This allows for more complex docking layout direction has a higher layer number. This allows for more complex docking layout
formation. formation.
*/ */
wxAuiPaneInfo Layer(int layer); wxAuiPaneInfo& Layer(int layer);
/** /**
Left() sets the pane dock position to the left side of the frame. This is the Left() sets the pane dock position to the left side of the frame. This is the
same thing as calling Direction(wxAUI_DOCK_LEFT). same thing as calling Direction(wxAUI_DOCK_LEFT).
*/ */
wxAuiPaneInfo Left(); wxAuiPaneInfo& Left();
/** /**
LeftDockable() indicates whether a pane can be docked on the left of the frame. LeftDockable() indicates whether a pane can be docked on the left of the frame.
*/ */
wxAuiPaneInfo LeftDockable(bool b = true); wxAuiPaneInfo& LeftDockable(bool b = true);
//@{ //@{
/** /**
@@ -655,7 +655,7 @@ public:
/** /**
MaximizeButton() indicates that a maximize button should be drawn for the pane. MaximizeButton() indicates that a maximize button should be drawn for the pane.
*/ */
wxAuiPaneInfo MaximizeButton(bool visible = true); wxAuiPaneInfo& MaximizeButton(bool visible = true);
//@{ //@{
/** /**
@@ -669,56 +669,56 @@ public:
/** /**
MinimizeButton() indicates that a minimize button should be drawn for the pane. MinimizeButton() indicates that a minimize button should be drawn for the pane.
*/ */
wxAuiPaneInfo MinimizeButton(bool visible = true); wxAuiPaneInfo& MinimizeButton(bool visible = true);
/** /**
Movable indicates whether a frame can be moved. Movable indicates whether a frame can be moved.
*/ */
wxAuiPaneInfo Movable(bool b = true); wxAuiPaneInfo& Movable(bool b = true);
/** /**
Name() sets the name of the pane so it can be referenced in lookup functions. Name() sets the name of the pane so it can be referenced in lookup functions.
If a name is not specified by the user, a random name is assigned to the pane If a name is not specified by the user, a random name is assigned to the pane
when it is added to the manager. when it is added to the manager.
*/ */
wxAuiPaneInfo Name(const wxString& n); wxAuiPaneInfo& Name(const wxString& n);
/** /**
PaneBorder indicates that a border should be drawn for the pane. PaneBorder indicates that a border should be drawn for the pane.
*/ */
wxAuiPaneInfo PaneBorder(bool visible = true); wxAuiPaneInfo& PaneBorder(bool visible = true);
/** /**
PinButton() indicates that a pin button should be drawn for the pane. PinButton() indicates that a pin button should be drawn for the pane.
*/ */
wxAuiPaneInfo PinButton(bool visible = true); wxAuiPaneInfo& PinButton(bool visible = true);
/** /**
Position() determines the position of the docked pane. Position() determines the position of the docked pane.
*/ */
wxAuiPaneInfo Position(int pos); wxAuiPaneInfo& Position(int pos);
/** /**
Resizable() allows a pane to be resized if the parameter is @true, and forces it Resizable() allows a pane to be resized if the parameter is @true, and forces it
to be a fixed size if the parameter is @false. This is simply an antonym for Fixed(). to be a fixed size if the parameter is @false. This is simply an antonym for Fixed().
*/ */
wxAuiPaneInfo Resizable(bool resizable = true); wxAuiPaneInfo& Resizable(bool resizable = true);
/** /**
Right() sets the pane dock position to the right side of the frame. Right() sets the pane dock position to the right side of the frame.
*/ */
wxAuiPaneInfo Right(); wxAuiPaneInfo& Right();
/** /**
RightDockable() indicates whether a pane can be docked on the right of the RightDockable() indicates whether a pane can be docked on the right of the
frame. frame.
*/ */
wxAuiPaneInfo RightDockable(bool b = true); wxAuiPaneInfo& RightDockable(bool b = true);
/** /**
Row() determines the row of the docked pane. Row() determines the row of the docked pane.
*/ */
wxAuiPaneInfo Row(int row); wxAuiPaneInfo& Row(int row);
/** /**
Write the safe parts of a newly loaded PaneInfo structure "source" into "this" Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
@@ -730,28 +730,28 @@ public:
SetFlag() turns the property given by flag on or off with the option_state SetFlag() turns the property given by flag on or off with the option_state
parameter. parameter.
*/ */
wxAuiPaneInfo SetFlag(unsigned int flag, bool option_state); wxAuiPaneInfo& SetFlag(unsigned int flag, bool option_state);
/** /**
Show() indicates that a pane should be shown. Show() indicates that a pane should be shown.
*/ */
wxAuiPaneInfo Show(bool show = true); wxAuiPaneInfo& Show(bool show = true);
/** /**
ToolbarPane() specifies that the pane should adopt the default toolbar pane ToolbarPane() specifies that the pane should adopt the default toolbar pane
settings. settings.
*/ */
wxAuiPaneInfo ToolbarPane(); wxAuiPaneInfo& ToolbarPane();
/** /**
Top() sets the pane dock position to the top of the frame. Top() sets the pane dock position to the top of the frame.
*/ */
wxAuiPaneInfo Top(); wxAuiPaneInfo& Top();
/** /**
TopDockable() indicates whether a pane can be docked at the top of the frame. TopDockable() indicates whether a pane can be docked at the top of the frame.
*/ */
wxAuiPaneInfo TopDockable(bool b = true); wxAuiPaneInfo& TopDockable(bool b = true);
/** /**
Window() assigns the window pointer that the wxAuiPaneInfo should use. Window() assigns the window pointer that the wxAuiPaneInfo should use.
@@ -759,7 +759,7 @@ public:
automatically assigned to the wxAuiPaneInfo structure as soon as it is added automatically assigned to the wxAuiPaneInfo structure as soon as it is added
to the manager. to the manager.
*/ */
wxAuiPaneInfo Window(wxWindow* w); wxAuiPaneInfo& Window(wxWindow* w);
/** /**
Makes a copy of the wxAuiPaneInfo object. Makes a copy of the wxAuiPaneInfo object.

View File

@@ -43,7 +43,7 @@ public:
/** /**
Destroys the wxBitmapHandler object. Destroys the wxBitmapHandler object.
*/ */
~wxBitmapHandler(); virtual ~wxBitmapHandler();
/** /**
Creates a bitmap from the given data, which can be of arbitrary type. Creates a bitmap from the given data, which can be of arbitrary type.
@@ -100,7 +100,7 @@ public:
@see wxBitmap::LoadFile, wxBitmap::SaveFile, SaveFile() @see wxBitmap::LoadFile, wxBitmap::SaveFile, SaveFile()
*/ */
bool LoadFile(wxBitmap* bitmap, const wxString& name, wxBitmapType type); virtual bool LoadFile(wxBitmap* bitmap, const wxString& name, wxBitmapType type);
/** /**
Saves a bitmap in the named file. Saves a bitmap in the named file.
@@ -311,7 +311,7 @@ public:
@warning @warning
Do not delete a bitmap that is selected into a memory device context. Do not delete a bitmap that is selected into a memory device context.
*/ */
~wxBitmap(); virtual ~wxBitmap();
/** /**
Adds a handler to the end of the static list of format handlers. Adds a handler to the end of the static list of format handlers.
@@ -348,7 +348,7 @@ public:
This overload works on all platforms. This overload works on all platforms.
*/ */
virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH); bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
/* /*
Creates a bitmap from the given data, which can be of arbitrary type. Creates a bitmap from the given data, which can be of arbitrary type.
@@ -657,7 +657,7 @@ public:
/** /**
Destroys the wxMask object and the underlying bitmap data. Destroys the wxMask object and the underlying bitmap data.
*/ */
~wxMask(); virtual ~wxMask();
/** /**
Constructs a mask from a bitmap and a palette index that indicates the Constructs a mask from a bitmap and a palette index that indicates the

View File

@@ -113,7 +113,7 @@ public:
/** /**
Destructor, destroying the button. Destructor, destroying the button.
*/ */
~wxBitmapButton(); virtual ~wxBitmapButton();
/** /**
Button creation function for two-step creation. Button creation function for two-step creation.
@@ -191,7 +191,7 @@ public:
@see GetBitmapDisabled(), SetBitmapLabel(), @see GetBitmapDisabled(), SetBitmapLabel(),
SetBitmapSelected(), SetBitmapFocus() SetBitmapSelected(), SetBitmapFocus()
*/ */
void SetBitmapDisabled(const wxBitmap& bitmap); virtual void SetBitmapDisabled(const wxBitmap& bitmap);
/** /**
Sets the bitmap for the button appearance when it has the keyboard focus. Sets the bitmap for the button appearance when it has the keyboard focus.
@@ -202,7 +202,7 @@ public:
@see GetBitmapFocus(), SetBitmapLabel(), @see GetBitmapFocus(), SetBitmapLabel(),
SetBitmapSelected(), SetBitmapDisabled() SetBitmapSelected(), SetBitmapDisabled()
*/ */
void SetBitmapFocus(const wxBitmap& bitmap); virtual void SetBitmapFocus(const wxBitmap& bitmap);
/** /**
Sets the bitmap to be shown when the mouse is over the button. Sets the bitmap to be shown when the mouse is over the button.
@@ -213,7 +213,7 @@ public:
@see GetBitmapHover() @see GetBitmapHover()
*/ */
void SetBitmapHover(const wxBitmap& bitmap); virtual void SetBitmapHover(const wxBitmap& bitmap);
/** /**
Sets the bitmap label for the button. Sets the bitmap label for the button.
@@ -226,7 +226,7 @@ public:
@see GetBitmapLabel() @see GetBitmapLabel()
*/ */
void SetBitmapLabel(const wxBitmap& bitmap); virtual void SetBitmapLabel(const wxBitmap& bitmap);
/** /**
Sets the bitmap for the selected (depressed) button appearance. Sets the bitmap for the selected (depressed) button appearance.
@@ -234,6 +234,6 @@ public:
@param bitmap @param bitmap
The bitmap to set. The bitmap to set.
*/ */
void SetBitmapSelected(const wxBitmap& bitmap); virtual void SetBitmapSelected(const wxBitmap& bitmap);
}; };

View File

@@ -111,7 +111,7 @@ public:
/** /**
Destructor, destroying the combobox. Destructor, destroying the combobox.
*/ */
~wxBitmapComboBox(); virtual ~wxBitmapComboBox();
/** /**
Adds the item to the end of the combo box. Adds the item to the end of the combo box.

View File

@@ -141,14 +141,14 @@ public:
object is stored in an application data structure, and there is object is stored in an application data structure, and there is
a risk of double deletion. a risk of double deletion.
*/ */
~wxBrush(); virtual ~wxBrush();
/** /**
Returns a reference to the brush colour. Returns a reference to the brush colour.
@see SetColour() @see SetColour()
*/ */
wxColour GetColour() const; wxColour& GetColour() const;
/** /**
Gets a pointer to the stipple bitmap. If the brush does not have a wxBRUSHSTYLE_STIPPLE Gets a pointer to the stipple bitmap. If the brush does not have a wxBRUSHSTYLE_STIPPLE
@@ -170,7 +170,7 @@ public:
@see GetStyle() @see GetStyle()
*/ */
bool IsHatch() const; virtual bool IsHatch() const;
/** /**
Returns @true if the brush is initialised. It will return @false if the default Returns @true if the brush is initialised. It will return @false if the default

View File

@@ -60,17 +60,17 @@ public:
/** /**
Returns the size of the buffer. Returns the size of the buffer.
*/ */
size_t GetBufSize(); size_t GetBufSize() const;
/** /**
Return a pointer to the data in the buffer. Return a pointer to the data in the buffer.
*/ */
void* GetData(); void* GetData() const;
/** /**
Returns the length of the valid data in the buffer. Returns the length of the valid data in the buffer.
*/ */
size_t GetDataLen(); size_t GetDataLen() const;
/** /**
Ensure the buffer is big enough and return a pointer to the Ensure the buffer is big enough and return a pointer to the

View File

@@ -67,6 +67,6 @@ public:
/** /**
Hides and closes the window containing the information text. Hides and closes the window containing the information text.
*/ */
~wxBusyInfo(); virtual ~wxBusyInfo();
}; };

View File

@@ -91,7 +91,7 @@ public:
/** /**
Destructor, destroying the button. Destructor, destroying the button.
*/ */
~wxButton(); virtual ~wxButton();
/** /**
Button creation function for two-step creation. Button creation function for two-step creation.
@@ -110,7 +110,7 @@ public:
buttons of the same size and this function allows to retrieve the (platform and buttons of the same size and this function allows to retrieve the (platform and
current font dependent size) which should be the best suited for this. current font dependent size) which should be the best suited for this.
*/ */
wxSize GetDefaultSize(); static wxSize GetDefaultSize();
/** /**
Returns the string label for the button. Returns the string label for the button.