interface fixes; removed many functions which were deprecated in past and have already been removed from wx; renamed others wrongly named; added some @onlyfor tags to avoid false warnings in ifacecheck logs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56785 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi 2008-11-15 11:37:43 +00:00
parent 6e6b083df2
commit 4ccf056633
18 changed files with 31 additions and 185 deletions

View File

@ -857,11 +857,6 @@ public:
*/
virtual bool ClearColumns();
/**
Unselects all rows.
*/
void ClearSelection();
/**
Collapses the item.
*/
@ -1597,14 +1592,14 @@ public:
/**
Returns @true if the column is reorderable.
*/
bool GetReorderable();
virtual bool IsReorderable() const;
/**
Returns @true if the column is sortable.
@see SetSortable()
*/
bool GetSortable();
virtual bool IsSortable() const;
/**
Returns the width of the column.

View File

@ -1797,7 +1797,7 @@ public:
date set to 0. Hours are not restricted to 0-24 range, neither are
minutes, seconds or milliseconds.
*/
wxTimeSpan(long hours, long min, long sec, long msec);
wxTimeSpan(long hours, long min = 0, wxLongLong sec = 0, wxLongLong msec = 0);
/**
Returns the absolute value of the timespan: does not modify the object.

View File

@ -136,13 +136,6 @@ public:
*/
void Clear();
/**
Performs all necessary computations for given platform and context type
after each change of scale and origin parameters. Usually called
automatically internally after such changes.
*/
virtual void ComputeScaleAndOrigin();
/**
Displays a cross hair using the current pen. This is a vertical and
horizontal line the height and width of the window, centred on the
@ -759,7 +752,7 @@ public:
/**
Returns @true if the DC is ok to use.
*/
bool Ok();
bool IsOk() const;
/**
Converts logical X coordinate to device coordinate, using the current

View File

@ -30,20 +30,6 @@ public:
you pass a pointer instead.
*/
wxPrinterDC(const wxPrintData& printData);
/**
Constructor. With empty strings for the first three arguments, the
default printer dialog is displayed. @a device indicates the type of
printer and @a output is an optional file for printing to. The
@a driver parameter is currently unused. Use the wxDC::Ok() member to
test whether the constructor was successful in creating a usable device
context.
@deprecated This constructor is deprecated and retained only for
backward compatibility.
*/
wxPrinterDC(const wxString& driver, const wxString& device,
const wxString& output, bool interactive = true,
int orientation = wxPORTRAIT);
/**
Return the rectangle in device coordinates that corresponds to the full
@ -54,6 +40,6 @@ public:
negative values, while the bottom right coordinates will be somewhat
larger than the values returned by wxDC::GetSize().
*/
wxRect wxPrinterDC::GetPaperRect();
wxRect GetPaperRect() const;
};

View File

@ -24,29 +24,12 @@ public:
*/
wxPostScriptDC(const wxPrintData& printData);
/**
Constructor. @a output is an optional file for printing to, and if
@a interactive is @true a dialog box will be displayed for adjusting
various parameters. @a parent is the parent of the printer dialog box.
Use the wxDC::Ok() member to test whether the constructor was
successful in creating a usable device context.
See wxPrintData for various functions to set and get PostScript
printing settings.
@deprecated This constructor is deprecated.
*/
wxPostScriptDC(const wxString& output,
bool interactive,
wxWindow* parent);
/**
Return resolution used in PostScript output.
@see SetResolution()
*/
static int GetResolution();
static int GetResolution() const;
/**
Set resolution (in pixels per inch) that will be used in PostScript

View File

@ -352,7 +352,7 @@ public:
/**
Not implemented.
*/
void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *width, wxCoord *height);
void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *width, wxCoord *height) const;
//@{
/**

View File

@ -11,8 +11,8 @@
A wxDDEConnection object represents the connection between a client and a
server. It can be created by making a connection using a wxDDEClient
object, or by the acceptance of a connection by a wxDDEServer object. The
bulk of a DDE (Dynamic Data Exchange) conversation is controlled by calling
object, or by the acceptance of a connection by a wxDDEServer object.
The bulk of a DDE (Dynamic Data Exchange) conversation is controlled by calling
members in a wxDDEConnection object or by overriding its members.
An application should normally derive a new connection class from
@ -25,6 +25,7 @@
@library{wxbase}
@category{ipc}
@onlyfor{wxmsw}
@see wxConnectionBase, wxDDEClient, wxDDEServer, @ref overview_ipc
*/
@ -222,6 +223,7 @@ public:
@library{wxbase}
@category{ipc}
@onlyfor{wxmsw}
@see wxDDEServer, wxDDEConnection, @ref overview_ipc
*/
@ -280,6 +282,7 @@ public:
@library{wxbase}
@category{ipc}
@onlyfor{wxmsw}
@see wxDDEClient, wxDDEConnection, @ref overview_ipc
*/

View File

@ -190,7 +190,7 @@ public:
@see @ref overview_dialog_autoscrolling (for more on layout adaptation)
*/
bool CanDoLayoutAdaptation();
virtual bool CanDoLayoutAdaptation();
/**
Centres the dialog box on the display.
@ -251,7 +251,7 @@ public:
@see @ref overview_dialog_autoscrolling (for more on layout adaptation)
*/
bool DoLayoutAdaptation();
virtual bool DoLayoutAdaptation();
/**
This function is called when the titlebar OK button is pressed
@ -259,6 +259,8 @@ public:
GetAffirmativeId() is sent by default. You can override this function.
If the function returns @false, wxWidgets will call Close() for the
dialog.
@onlyfor{wxmsw}
*/
virtual bool DoOK();
@ -362,6 +364,8 @@ public:
supported.
This function is not available on any other platform.
@onlyfor{wxmsw}
*/
wxToolBar* GetToolBar() const;
@ -400,9 +404,11 @@ public:
Returns @true if @a id is in the array of identifiers to be regarded as
the main buttons for the non-scrolling area of a dialog.
@onlyfor{wxmsw}
@see @ref overview_dialog_autoscrolling (for more on layout adaptation)
*/
bool IsMainButton(wxWindowID& id) const;
bool IsMainButtonId(wxWindowID id) const;
/**
Returns @true if the dialog box is modal, @false otherwise.

View File

@ -70,12 +70,6 @@ public:
*/
wxVideoMode GetCurrentMode() const;
/**
Returns the bit depth of the display whose index was passed to the
constructor.
*/
int GetDepth() const;
/**
Returns the index of the display on which the given point lies, or
@c wxNOT_FOUND if the point is not on any connected display.

View File

@ -166,6 +166,8 @@ public:
function, you can use just the base name of the function and the
correct suffix is appended automatically depending on the current
build. Otherwise, this method is identical to GetSymbol().
@onlyfor{wxmsw}
*/
void* GetSymbolAorW(const wxString& name) const;

View File

@ -53,14 +53,6 @@ public:
*/
wxHtmlHelpController* GetController() const;
/**
Reads the user's settings for this dialog
@see wxHtmlHelpController::ReadCustomization
*/
void ReadCustomization(wxConfigBase* cfg,
const wxString& path = wxEmptyString);
/**
Sets the help controller associated with the dialog.
*/
@ -72,13 +64,5 @@ public:
@a format must contain exactly one "%s" (it will be replaced by the page title).
*/
void SetTitleFormat(const wxString& format);
/**
Saves the user's settings for this dialog
@see wxHtmlHelpController::WriteCustomization
*/
void WriteCustomization(wxConfigBase* cfg,
const wxString& path = wxEmptyString);
};

View File

@ -56,14 +56,6 @@ public:
*/
wxHtmlHelpController* GetController() const;
/**
Reads the user's settings for this frame.
@see wxHtmlHelpController::ReadCustomization
*/
void ReadCustomization(wxConfigBase* cfg,
const wxString& path = wxEmptyString);
/**
Sets the help controller associated with the frame.
*/
@ -75,13 +67,5 @@ public:
@a format must contain exactly one "%s" (it will be replaced by the page title).
*/
void SetTitleFormat(const wxString& format);
/**
Saves the user's settings for this frame.
@see wxHtmlHelpController::WriteCustomization
*/
void WriteCustomization(wxConfigBase* cfg,
const wxString& path = wxEmptyString);
};

View File

@ -80,37 +80,6 @@ public:
*/
static int GetLevel();
/**
Returns the output stream associated with the debug context.
@deprecated
This is obsolete, replaced by wxLog functionality.
@see SetStream()
*/
ostream GetStream();
/**
Returns a pointer to the output stream buffer associated with the debug context.
There may not necessarily be a stream buffer if the stream has been set
by the user.
@deprecated
This is obsolete, replaced by wxLog functionality.
*/
streambuf* GetStreamBuf();
/**
Returns @true if there is a stream currently associated
with the debug context.
@deprecated
This is obsolete, replaced by wxLog functionality.
@see SetStream(), GetStream()
*/
bool HasStream();
/**
Prints a list of the classes declared in this application, giving derivation
and whether instances of this class can be dynamically created.
@ -167,15 +136,6 @@ public:
*/
static void SetDebugMode(bool debug);
/**
Sets the current debug file and creates a stream.
This will delete any existing stream and stream buffer.
By default, the debug context stream outputs to the debugger (Windows)
or standard error (other platforms).
*/
bool SetFile(const wxString& filename);
/**
Sets the debug level (default 1).
@ -199,31 +159,6 @@ public:
The shutdown function must be take no parameters and return nothing.
*/
static void SetShutdownNotifyFunction(wxShutdownNotifyFunction func);
/**
Sets the debugging stream to be the debugger (Windows) or standard error (other
platforms).
This is the default setting. The existing stream will be flushed and deleted.
@deprecated
This is obsolete, replaced by wxLog functionality.
*/
bool SetStandardError();
/**
Sets the stream and optionally, stream buffer associated with the debug context.
This operation flushes and deletes the existing stream (and stream buffer if any).
@deprecated
This is obsolete, replaced by wxLog functionality.
@param stream
Stream to associate with the debug context. Do not set this to @NULL.
@param streamBuf
Stream buffer to associate with the debug context.
*/
void SetStream(ostream* stream, streambuf* streamBuf = NULL);
};

View File

@ -202,25 +202,6 @@ public:
*/
virtual ~wxObject();
/**
A virtual function that may be redefined by derived classes to allow dumping of
memory states.
This function is only defined in debug build and exists only if @c __WXDEBUG__
is defined.
@param stream
Stream on which to output dump information.
@remarks Currently wxWidgets does not define Dump() for derived classes,
but programmers may wish to use it for their own applications.
Be sure to call the Dump member of the class's base class to allow all
information to be dumped.
The implementation of this function in wxObject just writes
the class name of the object.
*/
void Dump(ostream& stream);
/**
This virtual function is redefined for every class that requires run-time
type information, when using the ::DECLARE_CLASS macro (or similar).

View File

@ -121,6 +121,6 @@ public:
Shows the dialog, returning @c wxID_OK if the user pressed OK, and
@c wxID_CANCEL otherwise.
*/
virtual int ShowModal();
int ShowModal();
};

View File

@ -257,12 +257,12 @@ public:
@return @true on success, @false if something goes wrong (invalid @a service).
*/
virtual bool Service(unsigned short service);
virtual bool Service(unsigned short service) = 0;
/**
Returns the current service.
*/
virtual unsigned short Service() const;
virtual unsigned short Service() const = 0;
};

View File

@ -331,10 +331,10 @@ public:
*/
wxStyledTextCtrl::wxStyledTextCtrl(wxWindow* parent,
wxWindowID id = wxID_ANY,
const wxPoint pos = wxDefaultPosition,
const wxSize size = wxDefaultSize,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString name = "stcwindow");
const wxString& name = wxSTCNameStr);
/**
Extend life of document.
@ -597,7 +597,7 @@ public:
/**
Will a paste succeed?
*/
bool CanPaste();
virtual bool CanPaste() const;
/**
Are there any redoable actions in the undo history?

View File

@ -303,7 +303,7 @@ public:
/**
This constructor simply initializes a member variable.
*/
wxThreadHelper();
wxThreadHelper(wxThreadKind kind = wxTHREAD_JOINABLE);
/**
The destructor frees the resources associated with the thread.