More DocStr macro updates
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@27220 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -80,7 +80,7 @@ DocStr(CLSID,
|
|||||||
specify the class of the ActiveX object that is to be created. A
|
specify the class of the ActiveX object that is to be created. A
|
||||||
CLSID can be constructed from either a ProgID string, (such as
|
CLSID can be constructed from either a ProgID string, (such as
|
||||||
'WordPad.Document.1') or a classID string, (such as
|
'WordPad.Document.1') or a classID string, (such as
|
||||||
'{CA8A9783-280D-11CF-A24D-444553540000}').");
|
'{CA8A9783-280D-11CF-A24D-444553540000}').", "");
|
||||||
|
|
||||||
class CLSID {
|
class CLSID {
|
||||||
public:
|
public:
|
||||||
@@ -512,7 +512,7 @@ get/set properties or call methods by name. The Python
|
|||||||
implementation automatically handles converting parameters and
|
implementation automatically handles converting parameters and
|
||||||
return values to/from the types expected by the ActiveX code as
|
return values to/from the types expected by the ActiveX code as
|
||||||
specified by the TypeInfo.
|
specified by the TypeInfo.
|
||||||
");
|
", "");
|
||||||
|
|
||||||
|
|
||||||
class wxActiveXWindow : public wxWindow
|
class wxActiveXWindow : public wxWindow
|
||||||
@@ -527,28 +527,28 @@ public:
|
|||||||
long style = 0,
|
long style = 0,
|
||||||
const wxString& name = wxPyPanelNameStr),
|
const wxString& name = wxPyPanelNameStr),
|
||||||
"Creates an ActiveX control from the clsID given and makes it act
|
"Creates an ActiveX control from the clsID given and makes it act
|
||||||
as much like a regular wx.Window as possible.");
|
as much like a regular wx.Window as possible.", "");
|
||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
const CLSID& , GetCLSID() const,
|
const CLSID& , GetCLSID() const,
|
||||||
"Return the CLSID used to construct this ActiveX window");
|
"Return the CLSID used to construct this ActiveX window", "");
|
||||||
|
|
||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
int , GetAXEventCount() const,
|
int , GetAXEventCount() const,
|
||||||
"Number of events defined for this control");
|
"Number of events defined for this control", "");
|
||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
const wxFuncX& , GetAXEventDesc(int idx) const,
|
const wxFuncX& , GetAXEventDesc(int idx) const,
|
||||||
"Returns event description by index");
|
"Returns event description by index", "");
|
||||||
|
|
||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
int , GetAXPropCount() const,
|
int , GetAXPropCount() const,
|
||||||
"Number of properties defined for this control");
|
"Number of properties defined for this control", "");
|
||||||
|
|
||||||
%nokwargs GetAXPropDesc;
|
%nokwargs GetAXPropDesc;
|
||||||
DocStr(GetPropDesc, "Returns property description by index or by name");
|
DocStr(GetPropDesc, "Returns property description by index or by name", "");
|
||||||
const wxPropX& GetAXPropDesc(int idx) const;
|
const wxPropX& GetAXPropDesc(int idx) const;
|
||||||
const wxPropX& GetAXPropDesc(const wxString& name) const;
|
const wxPropX& GetAXPropDesc(const wxString& name) const;
|
||||||
|
|
||||||
@@ -556,10 +556,10 @@ as much like a regular wx.Window as possible.");
|
|||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
int , GetAXMethodCount() const,
|
int , GetAXMethodCount() const,
|
||||||
"Number of methods defined for this control");
|
"Number of methods defined for this control", "");
|
||||||
|
|
||||||
%nokwargs GetAXMethodDesc;
|
%nokwargs GetAXMethodDesc;
|
||||||
DocStr(GetMethodDesc, "Returns method description by index or name");
|
DocStr(GetMethodDesc, "Returns method description by index or name", "");
|
||||||
const wxFuncX& GetAXMethodDesc(int idx) const;
|
const wxFuncX& GetAXMethodDesc(int idx) const;
|
||||||
const wxFuncX& GetAXMethodDesc(const wxString& name) const;
|
const wxFuncX& GetAXMethodDesc(const wxString& name) const;
|
||||||
|
|
||||||
@@ -567,35 +567,35 @@ as much like a regular wx.Window as possible.");
|
|||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
const wxFuncXArray& , GetAXEvents(),
|
const wxFuncXArray& , GetAXEvents(),
|
||||||
"Returns a sequence of FuncX objects describing the events
|
"Returns a sequence of FuncX objects describing the events
|
||||||
available for this ActiveX object.");
|
available for this ActiveX object.", "");
|
||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
const wxFuncXArray& , GetAXMethods(),
|
const wxFuncXArray& , GetAXMethods(),
|
||||||
"Returns a sequence of FuncX objects describing the methods
|
"Returns a sequence of FuncX objects describing the methods
|
||||||
available for this ActiveX object.");
|
available for this ActiveX object.", "");
|
||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
const wxPropXArray& , GetAXProperties(),
|
const wxPropXArray& , GetAXProperties(),
|
||||||
"Returns a sequence of PropX objects describing the properties
|
"Returns a sequence of PropX objects describing the properties
|
||||||
available for this ActiveX object.");
|
available for this ActiveX object.", "");
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
void , SetAXProp(const wxString& name, PyObject* value),
|
void , SetAXProp(const wxString& name, PyObject* value),
|
||||||
"Set a property of the ActiveX object by name.");
|
"Set a property of the ActiveX object by name.", "");
|
||||||
|
|
||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
PyObject* , GetAXProp(const wxString& name),
|
PyObject* , GetAXProp(const wxString& name),
|
||||||
"Get the value of an ActiveX property by name.");
|
"Get the value of an ActiveX property by name.", "");
|
||||||
|
|
||||||
|
|
||||||
%nokwargs _CallAXMethod;
|
%nokwargs _CallAXMethod;
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
PyObject* , _CallAXMethod(const wxString& name, PyObject* args),
|
PyObject* , _CallAXMethod(const wxString& name, PyObject* args),
|
||||||
"The implementation for CallMethod. Calls an ActiveX method, by
|
"The implementation for CallMethod. Calls an ActiveX method, by
|
||||||
name passing the parameters given in args.");
|
name passing the parameters given in args.", "");
|
||||||
%pythoncode {
|
%pythoncode {
|
||||||
def CallAXMethod(self, name, *args):
|
def CallAXMethod(self, name, *args):
|
||||||
"""
|
"""
|
||||||
@@ -611,7 +611,7 @@ name passing the parameters given in args.");
|
|||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
wxEventType , RegisterActiveXEvent(const wxString& eventName),
|
wxEventType , RegisterActiveXEvent(const wxString& eventName),
|
||||||
"Creates a standard wx event ID for the given eventName.");
|
"Creates a standard wx event ID for the given eventName.", "");
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -620,7 +620,7 @@ DocStr(wxActiveXEvent,
|
|||||||
ActiveX events. Any event parameters from the ActiveX cntrol are
|
ActiveX events. Any event parameters from the ActiveX cntrol are
|
||||||
turned into attributes of the Python proxy for this event object.
|
turned into attributes of the Python proxy for this event object.
|
||||||
Additionally, there is a property called eventName that will
|
Additionally, there is a property called eventName that will
|
||||||
return (surprisingly <wink>) the name of the ActiveX event.");
|
return (surprisingly <wink>) the name of the ActiveX event.", "");
|
||||||
|
|
||||||
class wxActiveXEvent : public wxCommandEvent
|
class wxActiveXEvent : public wxCommandEvent
|
||||||
{
|
{
|
||||||
|
Reference in New Issue
Block a user