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

add @onlyfor tags to remove further ifacecheck warnings

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52862 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-27 20:54:47 +00:00
parent 5570107a9d
commit d9faa1fede
7 changed files with 79 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
interface/accel.h
View File

@@ -186,6 +186,8 @@ public:
/**
Loads the accelerator table from a Windows resource (Windows only).
@onlyfor{wxmsw}
@param resource
Name of a Windows accelerator.
*/

2
interface/animate.h
View File

@@ -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.

27
interface/app.h
View File

@@ -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);

17
interface/msw/ole/activex.h
View File

@@ -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}
@@ -87,7 +92,7 @@ public:
@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);
};

2
interface/msw/ole/automtn.h
View File

@@ -31,6 +31,8 @@
Note that this class obviously works under Windows only.
@onlyfor{wxmsw}
@library{wxcore}
@category{misc}

1
interface/msw/registry.h
View File

@@ -31,6 +31,7 @@
Multi String Value
Expandable String Value
@onlyfor{wxmsw}
@library{wxbase}
@category{FIXME}

59
interface/validate.h
View File

@@ -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;