/**
Loads the accelerator table from a Windows resource (Windows only).
+ @onlyfor{wxmsw}
+
@param resource
Name of a Windows accelerator.
*/
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.
public:
- /**
- Constructor.
- */
- wxAppConsole();
-
/**
Destructor.
*/
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();
return CWinApp::PreTranslateMessage(msg);
}
@endcode
+
+ @onlyfor{wxmsw}
*/
bool ProcessMessage(WXMSG* msg);
@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}
*/
You can also process activex events through wxEVT_ACTIVEX or the
corresponding message map macro EVT_ACTIVEX.
+ @onlyfor{wxmsw}
+
@library{wxbase}
@category{FIXME}
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);
};
Note that this class obviously works under Windows only.
+ @onlyfor{wxmsw}
+
@library{wxcore}
@category{misc}
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
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,
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.
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
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.
*/
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.
Multi String Value
Expandable String Value
+ @onlyfor{wxmsw}
@library{wxbase}
@category{FIXME}
/**
Gets information about the key.
-
+
@param pnSubKeys
The number of subkeys.
@param pnMaxKeyLen
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
{
~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;
/**
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;
projects / wxWidgets.git / commitdiff
