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
This commit is contained in:
@@ -186,6 +186,8 @@ public:
|
|||||||
/**
|
/**
|
||||||
Loads the accelerator table from a Windows resource (Windows only).
|
Loads the accelerator table from a Windows resource (Windows only).
|
||||||
|
|
||||||
|
@onlyfor{wxmsw}
|
||||||
|
|
||||||
@param resource
|
@param resource
|
||||||
Name of a Windows accelerator.
|
Name of a Windows accelerator.
|
||||||
*/
|
*/
|
||||||
|
@@ -66,7 +66,7 @@ public:
|
|||||||
const wxPoint& pos = wxDefaultPosition,
|
const wxPoint& pos = wxDefaultPosition,
|
||||||
const wxSize& size = wxDefaultSize,
|
const wxSize& size = wxDefaultSize,
|
||||||
long style = wxAC_DEFAULT_STYLE,
|
long style = wxAC_DEFAULT_STYLE,
|
||||||
const wxString& name = "animationctrl");
|
const wxString& name = wxAnimationCtrlNameStr);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Creates the control with the given @a anim animation.
|
Creates the control with the given @a anim animation.
|
||||||
|
@@ -33,11 +33,6 @@ protected:
|
|||||||
|
|
||||||
public:
|
public:
|
||||||
|
|
||||||
/**
|
|
||||||
Constructor.
|
|
||||||
*/
|
|
||||||
wxAppConsole();
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Destructor.
|
Destructor.
|
||||||
*/
|
*/
|
||||||
@@ -165,32 +160,42 @@ public:
|
|||||||
static bool IsMainLoopRunning();
|
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.
|
Override this to create a new document in your app.
|
||||||
|
|
||||||
|
@onlyfor{wxmac}
|
||||||
*/
|
*/
|
||||||
virtual void MacNewFile();
|
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
|
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
|
user double clicked on it or if the document file was dropped on either the
|
||||||
running application or the application icon in Finder.
|
running application or the application icon in Finder.
|
||||||
|
|
||||||
|
@onlyfor{wxmac}
|
||||||
*/
|
*/
|
||||||
virtual void MacOpenFile(const wxString& fileName);
|
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);
|
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);
|
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();
|
virtual void MacReopenApp();
|
||||||
|
|
||||||
@@ -560,6 +565,8 @@ public:
|
|||||||
return CWinApp::PreTranslateMessage(msg);
|
return CWinApp::PreTranslateMessage(msg);
|
||||||
}
|
}
|
||||||
@endcode
|
@endcode
|
||||||
|
|
||||||
|
@onlyfor{wxmsw}
|
||||||
*/
|
*/
|
||||||
bool ProcessMessage(WXMSG* msg);
|
bool ProcessMessage(WXMSG* msg);
|
||||||
|
|
||||||
|
@@ -10,14 +10,17 @@
|
|||||||
@class wxActiveXEvent
|
@class wxActiveXEvent
|
||||||
@headerfile ole/activex.h wx/msw/ole/activex.h
|
@headerfile ole/activex.h wx/msw/ole/activex.h
|
||||||
|
|
||||||
An event class for handling activex events passed from
|
An event class for handling activex events passed from wxActiveXContainer.
|
||||||
wxActiveXContainer. ActiveX events are basically
|
|
||||||
a function call with the parameters passed through an array of wxVariants along
|
ActiveX events are basically a function call with the parameters passed
|
||||||
with a return value that is a wxVariant itself. What type the parameters or
|
through an array of wxVariants along with a return value that is a wxVariant
|
||||||
return value are depends on the context (i.e. what the .idl specifies).
|
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.
|
Note that unlike the third party wxActiveX function names are not supported.
|
||||||
|
|
||||||
|
@onlyfor{wxmsw}
|
||||||
|
|
||||||
@library{wxbase}
|
@library{wxbase}
|
||||||
@category{FIXME}
|
@category{FIXME}
|
||||||
*/
|
*/
|
||||||
@@ -71,6 +74,8 @@ public:
|
|||||||
You can also process activex events through wxEVT_ACTIVEX or the
|
You can also process activex events through wxEVT_ACTIVEX or the
|
||||||
corresponding message map macro EVT_ACTIVEX.
|
corresponding message map macro EVT_ACTIVEX.
|
||||||
|
|
||||||
|
@onlyfor{wxmsw}
|
||||||
|
|
||||||
@library{wxbase}
|
@library{wxbase}
|
||||||
@category{FIXME}
|
@category{FIXME}
|
||||||
|
|
||||||
@@ -81,13 +86,13 @@ class wxActiveXContainer : public wxControl
|
|||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
Creates this activex container.
|
Creates this activex container.
|
||||||
|
|
||||||
@param parent
|
@param parent
|
||||||
parent of this control. Must not be @NULL.
|
parent of this control. Must not be @NULL.
|
||||||
@param iid
|
@param iid
|
||||||
COM IID of pUnk to query. Must be a valid interface to an activex control.
|
COM IID of pUnk to query. Must be a valid interface to an activex control.
|
||||||
@param pUnk
|
@param pUnk
|
||||||
Interface of activex control
|
Interface of activex control.
|
||||||
*/
|
*/
|
||||||
wxActiveXContainer(wxWindow* parent, REFIID iid, IUnknown* pUnk);
|
wxActiveXContainer(wxWindow* parent, REFIID iid, IUnknown* pUnk);
|
||||||
};
|
};
|
||||||
|
@@ -31,6 +31,8 @@
|
|||||||
|
|
||||||
Note that this class obviously works under Windows only.
|
Note that this class obviously works under Windows only.
|
||||||
|
|
||||||
|
@onlyfor{wxmsw}
|
||||||
|
|
||||||
@library{wxcore}
|
@library{wxcore}
|
||||||
@category{misc}
|
@category{misc}
|
||||||
|
|
||||||
@@ -62,7 +64,7 @@ public:
|
|||||||
data types, and C++ provides temporary objects automatically, both of the
|
data types, and C++ provides temporary objects automatically, both of the
|
||||||
following lines
|
following lines
|
||||||
are syntactically valid:
|
are syntactically valid:
|
||||||
|
|
||||||
Note that @a method can contain dot-separated property names, to save the
|
Note that @a method can contain dot-separated property names, to save the
|
||||||
application
|
application
|
||||||
needing to call GetProperty several times using several temporary objects. For
|
needing to call GetProperty several times using several temporary objects. For
|
||||||
@@ -106,7 +108,7 @@ public:
|
|||||||
from other objects.
|
from other objects.
|
||||||
Note that an IDispatch pointer is stored as a void* pointer in wxVariant
|
Note that an IDispatch pointer is stored as a void* pointer in wxVariant
|
||||||
objects.
|
objects.
|
||||||
|
|
||||||
@see GetProperty()
|
@see GetProperty()
|
||||||
*/
|
*/
|
||||||
bool GetObject(wxAutomationObject& obj, const wxString& property,
|
bool GetObject(wxAutomationObject& obj, const wxString& property,
|
||||||
@@ -124,7 +126,7 @@ public:
|
|||||||
data types, and C++ provides temporary objects automatically, both of the
|
data types, and C++ provides temporary objects automatically, both of the
|
||||||
following lines
|
following lines
|
||||||
are syntactically valid:
|
are syntactically valid:
|
||||||
|
|
||||||
Note that @a property can contain dot-separated property names, to save the
|
Note that @a property can contain dot-separated property names, to save the
|
||||||
application
|
application
|
||||||
needing to call GetProperty several times using several temporary objects.
|
needing to call GetProperty several times using several temporary objects.
|
||||||
@@ -139,7 +141,7 @@ public:
|
|||||||
Invoke function.
|
Invoke function.
|
||||||
It is not meant to be called directly by the application, but is used by other
|
It is not meant to be called directly by the application, but is used by other
|
||||||
convenience functions.
|
convenience functions.
|
||||||
|
|
||||||
@param member
|
@param member
|
||||||
The member function or property name.
|
The member function or property name.
|
||||||
@param action
|
@param action
|
||||||
@@ -153,9 +155,9 @@ public:
|
|||||||
If non-null, contains an array of variants.
|
If non-null, contains an array of variants.
|
||||||
@param ptrArgs
|
@param ptrArgs
|
||||||
If non-null, contains an array of constant pointers to variants.
|
If non-null, contains an array of constant pointers to variants.
|
||||||
|
|
||||||
@returns @true if the operation was successful, @false otherwise.
|
@returns @true if the operation was successful, @false otherwise.
|
||||||
|
|
||||||
@remarks Two types of argument array are provided, so that when possible
|
@remarks Two types of argument array are provided, so that when possible
|
||||||
pointers are used for efficiency.
|
pointers are used for efficiency.
|
||||||
*/
|
*/
|
||||||
@@ -175,7 +177,7 @@ public:
|
|||||||
data types, and C++ provides temporary objects automatically, both of the
|
data types, and C++ provides temporary objects automatically, both of the
|
||||||
following lines
|
following lines
|
||||||
are syntactically valid:
|
are syntactically valid:
|
||||||
|
|
||||||
Note that @a property can contain dot-separated property names, to save the
|
Note that @a property can contain dot-separated property names, to save the
|
||||||
application
|
application
|
||||||
needing to call GetProperty several times using several temporary objects.
|
needing to call GetProperty several times using several temporary objects.
|
||||||
|
@@ -31,6 +31,7 @@
|
|||||||
Multi String Value
|
Multi String Value
|
||||||
Expandable String Value
|
Expandable String Value
|
||||||
|
|
||||||
|
@onlyfor{wxmsw}
|
||||||
|
|
||||||
@library{wxbase}
|
@library{wxbase}
|
||||||
@category{FIXME}
|
@category{FIXME}
|
||||||
@@ -91,7 +92,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Gets information about the key.
|
Gets information about the key.
|
||||||
|
|
||||||
@param pnSubKeys
|
@param pnSubKeys
|
||||||
The number of subkeys.
|
The number of subkeys.
|
||||||
@param pnMaxKeyLen
|
@param pnMaxKeyLen
|
||||||
|
@@ -15,27 +15,30 @@
|
|||||||
|
|
||||||
A validator has three major roles:
|
A validator has three major roles:
|
||||||
|
|
||||||
to transfer data from a C++ variable or own storage to and from a control;
|
@li 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;
|
@li to validate data in a control, and show an appropriate error message;
|
||||||
to filter events (such as keystrokes), thereby changing the behaviour of the
|
@li to filter events (such as keystrokes), thereby changing the behaviour of the
|
||||||
associated control.
|
associated control.
|
||||||
|
|
||||||
Validators can be plugged into controls dynamically.
|
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
|
For more information, please see @ref overview_validator.
|
||||||
overview".
|
|
||||||
|
|
||||||
@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
|
derive the class from @c wxPyValidator in order to get Python-aware
|
||||||
capabilities for the various virtual methods.
|
capabilities for the various virtual methods.
|
||||||
|
@endWxPythonOnly
|
||||||
|
|
||||||
@library{wxcore}
|
@library{wxcore}
|
||||||
@category{validator}
|
@category{validator}
|
||||||
|
|
||||||
@see @ref overview_validatoroverview "Validator overview", wxTextValidator,
|
@stdobjects
|
||||||
wxGenericValidator,
|
::wxDefaultValidator
|
||||||
|
|
||||||
|
@see @ref overview_validator, wxTextValidator, wxGenericValidator
|
||||||
*/
|
*/
|
||||||
class wxValidator : public wxEvtHandler
|
class wxValidator : public wxEvtHandler
|
||||||
{
|
{
|
||||||
@@ -51,13 +54,15 @@ public:
|
|||||||
~wxValidator();
|
~wxValidator();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
All validator classes must implement the @b Clone function, which returns
|
All validator classes must implement the Clone() function, which returns
|
||||||
an identical copy of itself. This is because validators are passed to control
|
an identical copy of itself.
|
||||||
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
|
This is because validators are passed to control constructors as references
|
||||||
to do this cloning, because all validators should have separate
|
which must be copied. Unlike objects such as pens and brushes, it does not
|
||||||
data.
|
make sense to have a reference counting scheme to do this cloning, because
|
||||||
This base function returns @NULL.
|
all validators should have separate data.
|
||||||
|
|
||||||
|
@returns this base function returns @NULL.
|
||||||
*/
|
*/
|
||||||
virtual wxObject* Clone() const;
|
virtual wxObject* Clone() const;
|
||||||
|
|
||||||
@@ -79,23 +84,31 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
This overridable function is called when the value in the window must be
|
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
|
This overridable function is called when the value associated with the
|
||||||
validator must be
|
validator must be transferred to the window.
|
||||||
transferred to the window. Return @false if there is a problem.
|
|
||||||
|
@return @false if there is a problem.
|
||||||
*/
|
*/
|
||||||
virtual bool TransferToWindow();
|
virtual bool TransferToWindow();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
This overridable function is called when the value in the associated window
|
This overridable function is called when the value in the associated window
|
||||||
must be validated.
|
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);
|
virtual bool Validate(wxWindow* parent);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
An empty wxValidator instance.
|
||||||
|
*/
|
||||||
|
wxValidator wxDefaultValidator;
|
||||||
|
Reference in New Issue
Block a user