From: Francesco Montorsi Date: Thu, 27 Mar 2008 20:54:47 +0000 (+0000) Subject: add @onlyfor tags to remove further ifacecheck warnings X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/d9faa1fede04455b98de64001bcad46fa2061231?ds=sidebyside add @onlyfor tags to remove further ifacecheck warnings git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52862 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/interface/accel.h b/interface/accel.h index e200513125..2763733330 100644 --- a/interface/accel.h +++ b/interface/accel.h @@ -186,6 +186,8 @@ public: /** Loads the accelerator table from a Windows resource (Windows only). + @onlyfor{wxmsw} + @param resource Name of a Windows accelerator. */ diff --git a/interface/animate.h b/interface/animate.h index 861625aec3..7fb3a9a3d5 100644 --- a/interface/animate.h +++ b/interface/animate.h @@ -66,7 +66,7 @@ public: const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxAC_DEFAULT_STYLE, - const wxString& name = "animationctrl"); + const wxString& name = wxAnimationCtrlNameStr); /** Creates the control with the given @a anim animation. diff --git a/interface/app.h b/interface/app.h index d23bbd2153..7d0f82bafd 100644 --- a/interface/app.h +++ b/interface/app.h @@ -33,11 +33,6 @@ protected: public: - /** - Constructor. - */ - wxAppConsole(); - /** Destructor. */ @@ -165,32 +160,42 @@ public: static bool IsMainLoopRunning(); /** - Mac specific. Called in response of an "open-application" Apple event. + Called in response of an "open-application" Apple event. Override this to create a new document in your app. + + @onlyfor{wxmac} */ virtual void MacNewFile(); /** - Mac specific. Called in response of an "open-document" Apple event. + Called in response of an "open-document" Apple event. You need to override this method in order to open a document file after the user double clicked on it or if the document file was dropped on either the running application or the application icon in Finder. + + @onlyfor{wxmac} */ virtual void MacOpenFile(const wxString& fileName); /** - Mac specific. Called in response of a "get-url" Apple event. + Called in response of a "get-url" Apple event. + + @onlyfor{wxmac} */ virtual void MacOpenURL(const wxString& url); /** - Mac specific. Called in response of a "print-document" Apple event. + Called in response of a "print-document" Apple event. + + @onlyfor{wxmac} */ virtual void MacPrintFile(const wxString& fileName); /** - Mac specific. Called in response of a "reopen-application" Apple event. + Called in response of a "reopen-application" Apple event. + + @onlyfor{wxmac} */ virtual void MacReopenApp(); @@ -560,6 +565,8 @@ public: return CWinApp::PreTranslateMessage(msg); } @endcode + + @onlyfor{wxmsw} */ bool ProcessMessage(WXMSG* msg); diff --git a/interface/msw/ole/activex.h b/interface/msw/ole/activex.h index d3a0c9fdef..84dd86c428 100644 --- a/interface/msw/ole/activex.h +++ b/interface/msw/ole/activex.h @@ -10,14 +10,17 @@ @class wxActiveXEvent @headerfile ole/activex.h wx/msw/ole/activex.h - An event class for handling activex events passed from - wxActiveXContainer. ActiveX events are basically - a function call with the parameters passed through an array of wxVariants along - with a return value that is a wxVariant itself. What type the parameters or - return value are depends on the context (i.e. what the .idl specifies). + An event class for handling activex events passed from wxActiveXContainer. + + ActiveX events are basically a function call with the parameters passed + through an array of wxVariants along with a return value that is a wxVariant + itself. What type the parameters or return value are depends on the context + (i.e. what the .idl specifies). Note that unlike the third party wxActiveX function names are not supported. + @onlyfor{wxmsw} + @library{wxbase} @category{FIXME} */ @@ -71,6 +74,8 @@ public: You can also process activex events through wxEVT_ACTIVEX or the corresponding message map macro EVT_ACTIVEX. + @onlyfor{wxmsw} + @library{wxbase} @category{FIXME} @@ -81,13 +86,13 @@ class wxActiveXContainer : public wxControl public: /** Creates this activex container. - + @param parent parent of this control. Must not be @NULL. @param iid COM IID of pUnk to query. Must be a valid interface to an activex control. @param pUnk - Interface of activex control + Interface of activex control. */ wxActiveXContainer(wxWindow* parent, REFIID iid, IUnknown* pUnk); }; diff --git a/interface/msw/ole/automtn.h b/interface/msw/ole/automtn.h index d753fe9bb0..982efbe01a 100644 --- a/interface/msw/ole/automtn.h +++ b/interface/msw/ole/automtn.h @@ -31,6 +31,8 @@ Note that this class obviously works under Windows only. + @onlyfor{wxmsw} + @library{wxcore} @category{misc} @@ -62,7 +64,7 @@ public: data types, and C++ provides temporary objects automatically, both of the following lines are syntactically valid: - + Note that @a method can contain dot-separated property names, to save the application needing to call GetProperty several times using several temporary objects. For @@ -106,7 +108,7 @@ public: from other objects. Note that an IDispatch pointer is stored as a void* pointer in wxVariant objects. - + @see GetProperty() */ bool GetObject(wxAutomationObject& obj, const wxString& property, @@ -124,7 +126,7 @@ public: data types, and C++ provides temporary objects automatically, both of the following lines are syntactically valid: - + Note that @a property can contain dot-separated property names, to save the application needing to call GetProperty several times using several temporary objects. @@ -139,7 +141,7 @@ public: Invoke function. It is not meant to be called directly by the application, but is used by other convenience functions. - + @param member The member function or property name. @param action @@ -153,9 +155,9 @@ public: If non-null, contains an array of variants. @param ptrArgs If non-null, contains an array of constant pointers to variants. - + @returns @true if the operation was successful, @false otherwise. - + @remarks Two types of argument array are provided, so that when possible pointers are used for efficiency. */ @@ -175,7 +177,7 @@ public: data types, and C++ provides temporary objects automatically, both of the following lines are syntactically valid: - + Note that @a property can contain dot-separated property names, to save the application needing to call GetProperty several times using several temporary objects. diff --git a/interface/msw/registry.h b/interface/msw/registry.h index 6b2ccdcee6..1dc14d4eff 100644 --- a/interface/msw/registry.h +++ b/interface/msw/registry.h @@ -31,6 +31,7 @@ Multi String Value Expandable String Value + @onlyfor{wxmsw} @library{wxbase} @category{FIXME} @@ -91,7 +92,7 @@ public: /** Gets information about the key. - + @param pnSubKeys The number of subkeys. @param pnMaxKeyLen diff --git a/interface/validate.h b/interface/validate.h index ad1376d864..b4f1a07831 100644 --- a/interface/validate.h +++ b/interface/validate.h @@ -15,27 +15,30 @@ A validator has three major roles: - to transfer data from a C++ variable or own storage to and from a control; - to validate data in a control, and show an appropriate error message; - to filter events (such as keystrokes), thereby changing the behaviour of the - associated control. + @li to transfer data from a C++ variable or own storage to and from a control; + @li to validate data in a control, and show an appropriate error message; + @li to filter events (such as keystrokes), thereby changing the behaviour of the + associated control. Validators can be plugged into controls dynamically. - To specify a default, 'null' validator, use the symbol @b wxDefaultValidator. + To specify a default, 'null' validator, use the symbol ::wxDefaultValidator. - For more information, please see @ref overview_validatoroverview "Validator - overview". + For more information, please see @ref overview_validator. - @b wxPython note: If you wish to create a validator class in wxPython you should + @beginWxPythonOnly + If you wish to create a validator class in wxPython you should derive the class from @c wxPyValidator in order to get Python-aware capabilities for the various virtual methods. + @endWxPythonOnly @library{wxcore} @category{validator} - @see @ref overview_validatoroverview "Validator overview", wxTextValidator, - wxGenericValidator, + @stdobjects + ::wxDefaultValidator + + @see @ref overview_validator, wxTextValidator, wxGenericValidator */ class wxValidator : public wxEvtHandler { @@ -51,13 +54,15 @@ public: ~wxValidator(); /** - All validator classes must implement the @b Clone function, which returns - an identical copy of itself. This is because validators are passed to control - constructors as references which must be copied. Unlike objects such as pens - and brushes, it does not make sense to have a reference counting scheme - to do this cloning, because all validators should have separate - data. - This base function returns @NULL. + All validator classes must implement the Clone() function, which returns + an identical copy of itself. + + This is because validators are passed to control constructors as references + which must be copied. Unlike objects such as pens and brushes, it does not + make sense to have a reference counting scheme to do this cloning, because + all validators should have separate data. + + @returns this base function returns @NULL. */ virtual wxObject* Clone() const; @@ -79,23 +84,31 @@ public: /** This overridable function is called when the value in the window must be - transferred to the validator. Return @false if there is a problem. + transferred to the validator. + + @return @false if there is a problem. */ - virtual bool TransferToWindow(); + virtual bool TransferFromWindow(); /** This overridable function is called when the value associated with the - validator must be - transferred to the window. Return @false if there is a problem. + validator must be transferred to the window. + + @return @false if there is a problem. */ virtual bool TransferToWindow(); /** This overridable function is called when the value in the associated window must be validated. - Return @false if the value in the window is not valid; you may pop up an error - dialog. + + @return @false if the value in the window is not valid; you may pop up an error + dialog. */ virtual bool Validate(wxWindow* parent); }; +/** + An empty wxValidator instance. +*/ +wxValidator wxDefaultValidator;