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

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -9,15 +9,15 @@
/**
@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).
Note that unlike the third party wxActiveX function names are not supported.
@library{wxbase}
@category{FIXME}
*/
@@ -55,24 +55,24 @@ public:
/**
@class wxActiveXContainer
@headerfile ole/activex.h wx/msw/ole/activex.h
wxActiveXContainer is a host for an activex control on Windows (and
as such is a platform-specific class). Note that the HWND that the class
contains is the actual HWND of the activex control so using dynamic events
and connecting to wxEVT_SIZE, for example, will recieve the actual size
message sent to the control.
It is somewhat similar to the ATL class CAxWindow in operation.
The size of the activex control's content is generally gauranteed to be that
of the client size of the parent of this wxActiveXContainer.
You can also process activex events through wxEVT_ACTIVEX or the
corresponding message map macro EVT_ACTIVEX.
@library{wxbase}
@category{FIXME}
@seealso
wxActiveXEvent
*/
@@ -82,14 +82,12 @@ 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
@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
*/
wxActiveXContainer(wxWindow* parent, REFIID iid, IUnknown* pUnk);
};

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

@@ -9,31 +9,31 @@
/**
@class wxAutomationObject
@headerfile ole/automtn.h wx/msw/ole/automtn.h
The @b wxAutomationObject class represents an OLE automation object containing
a single data member,
an IDispatch pointer. It contains a number of functions that make it easy to
perform
automation operations, and set and get properties. The class makes heavy use of
the wxVariant class.
The usage of these classes is quite close to OLE automation usage in Visual
Basic. The API is
high-level, and the application can specify multiple properties in a single
string. The following example
gets the current Excel instance, and if it exists, makes the active cell bold.
@code
wxAutomationObject excelObject;
if (excelObject.GetInstance("Excel.Application"))
excelObject.PutProperty("ActiveCell.Font.Bold", @true);
@endcode
Note that this class obviously works under Windows only.
@library{wxcore}
@category{misc}
@seealso
wxVariant
*/
@@ -45,7 +45,7 @@ public:
the
object is deleted.
*/
wxAutomationObject(WXIDISPATCH* dispatchPtr = @NULL);
wxAutomationObject(WXIDISPATCH* dispatchPtr = NULL);
/**
Destructor. If the internal IDispatch pointer is non-null, it will be released.
@@ -64,15 +64,14 @@ public:
following lines
are syntactically valid:
Note that @e method can contain dot-separated property names, to save the
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
example:
*/
wxVariant CallMethod(const wxString& method, int noArgs,
wxVariant args[]);
wxVariant CallMethod(const wxString& method, ... );
wxVariant CallMethod(const wxString& method, ... );
//@}
/**
@@ -92,7 +91,6 @@ public:
IDispatch pointer
to this object. Returns @true if a pointer was successfully retrieved, @false
otherwise.
Note that this cannot cope with two instances of a given OLE object being
active simultaneously,
such as two copies of Excel running. Which object is referenced cannot
@@ -102,20 +100,19 @@ public:
/**
Retrieves a property from this object, assumed to be a dispatch pointer, and
initialises @e obj with it.
initialises @a obj with it.
To avoid having to deal with IDispatch pointers directly, use this function in
preference
to GetProperty() when retrieving objects
from other objects.
Note that an IDispatch pointer is stored as a void* pointer in wxVariant
objects.
@sa GetProperty()
@see GetProperty()
*/
bool GetObject(wxAutomationObject& obj, const wxString& property,
int noArgs = 0,
wxVariant args[] = @NULL);
wxVariant args[] = NULL);
//@{
/**
@@ -129,14 +126,13 @@ public:
following lines
are syntactically valid:
Note that @e property can contain dot-separated property names, to save the
Note that @a property can contain dot-separated property names, to save the
application
needing to call GetProperty several times using several temporary objects.
*/
wxVariant GetProperty(const wxString& property, int noArgs,
wxVariant args[]);
wxVariant GetProperty(const wxString& property, ... );
wxVariant GetProperty(const wxString& property, ... );
//@}
/**
@@ -145,29 +141,24 @@ public:
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
Bitlist: may contain DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF,
DISPATCH_METHOD.
@param retValue
Return value (ignored if there is no return value)
@param noArgs
Number of arguments in args or ptrArgs.
@param args
If non-null, contains an array of variants.
@param ptrArgs
If non-null, contains an array of constant pointers to variants.
@param member
The member function or property name.
@param action
Bitlist: may contain DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF,
DISPATCH_METHOD.
@param retValue
Return value (ignored if there is no return value)
@param noArgs
Number of arguments in args or ptrArgs.
@param args
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.
pointers are used for efficiency.
*/
bool Invoke(const wxString& member, int action,
wxVariant& retValue, int noArgs,
@@ -186,20 +177,18 @@ public:
following lines
are syntactically valid:
Note that @e property can contain dot-separated property names, to save the
Note that @a property can contain dot-separated property names, to save the
application
needing to call GetProperty several times using several temporary objects.
*/
bool PutProperty(const wxString& property, int noArgs,
wxVariant args[]);
bool PutProperty(const wxString& property, ... );
bool PutProperty(const wxString& property, ... );
//@}
/**
Sets the IDispatch pointer. This function does not check if there is already an
IDispatch pointer.
You may need to cast from IDispatch* to WXIDISPATCH* when calling this function.
*/
void SetDispatchPtr(WXIDISPATCH* dispatchPtr);

47
interface/msw/registry.h
View File

@@ -54,15 +54,15 @@ public:
void Close();
/**
Creates the key. Will fail if the key already exists and @e bOkIfExists is
Creates the key. Will fail if the key already exists and @a bOkIfExists is
@false.
*/
bool Create(bool bOkIfExists = @true);
bool Create(bool bOkIfExists = true);
/**
Deletes the subkey with all of its subkeys/values recursively.
*/
void DeleteKey(const wxChar * szKey);
void DeleteKey(const wxChar* szKey);
/**
Deletes this key and all of its subkeys and values recursively.
@@ -72,7 +72,7 @@ public:
/**
Deletes the named value.
*/
void DeleteValue(const wxChar * szKey);
void DeleteValue(const wxChar* szKey);
/**
Returns @true if the key exists.
@@ -93,24 +93,21 @@ public:
Gets information about the key.
@param pnSubKeys
The number of subkeys.
The number of subkeys.
@param pnMaxKeyLen
The maximum length of the subkey name.
The maximum length of the subkey name.
@param pnValues
The number of values.
The number of values.
@param pnMaxValueLen
The maximum length of a value.
The maximum length of a value.
*/
bool GetKeyInfo(size_t * pnSubKeys, size_t * pnValues,
size_t * pnMaxValueLen);
bool GetKeyInfo(size_t* pnSubKeys, size_t* pnValues,
size_t* pnMaxValueLen);
/**
Gets the name of the registry key.
*/
wxString GetName(bool bShortPrefix = @true);
wxString GetName(bool bShortPrefix = true);
/**
Gets the next key.
@@ -125,7 +122,7 @@ public:
/**
Returns @true if given subkey exists.
*/
bool HasSubKey(const wxChar * szKey);
bool HasSubKey(const wxChar* szKey);
/**
Returns @true if any subkeys exist.
@@ -135,7 +132,7 @@ public:
/**
Returns @true if the value exists.
*/
bool HasValue(const wxChar * szValue);
bool HasValue(const wxChar* szValue);
/**
Returns @true if any values exist.
@@ -163,30 +160,30 @@ public:
/**
Retrieves the numeric value.
*/
bool QueryValue(const wxChar * szValue, wxString& strValue);
bool QueryValue(const wxChar * szValue, long * plValue);
bool QueryValue(const wxChar* szValue, wxString& strValue);
bool QueryValue(const wxChar* szValue, long* plValue);
//@}
/**
Renames the key.
*/
bool Rename(const wxChar * szNewName);
bool Rename(const wxChar* szNewName);
/**
Renames a value.
*/
bool RenameValue(const wxChar * szValueOld,
const wxChar * szValueNew);
bool RenameValue(const wxChar* szValueOld,
const wxChar* szValueNew);
//@{
/**
Sets the given @e szValue which must be numeric, string or binary depending
Sets the given @a szValue which must be numeric, string or binary depending
on the overload used. If the value doesn't exist, it is created.
*/
bool SetValue(const wxChar * szValue, long lValue);
bool SetValue(const wxChar * szValue,
bool SetValue(const wxChar* szValue, long lValue);
bool SetValue(const wxChar* szValue,
const wxString& strValue);
bool SetValue(const wxChar * szValue,
bool SetValue(const wxChar* szValue,
const wxMemoryBuffer& buf);
//@}
};