/////////////////////////////////////////////////////////////////////////////
// Name: dde.h
-// Purpose: documentation for wxDDEConnection class
+// Purpose: interface of wxDDEConnection
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxDDEConnection
@wxheader{dde.h}
-
+
A wxDDEConnection object represents the connection between a client and a
server. It can be created by making a connection using a
wxDDEClient object, or by the acceptance of a connection by a
conversation is controlled by
calling members in a @b wxDDEConnection object or by overriding its
members.
-
+
An application should normally derive a new connection class from
wxDDEConnection, in order to override the communication event handlers
to do something interesting.
-
+
This DDE-based implementation is available on Windows only,
but a platform-independent, socket-based version
of this API is available using wxTCPConnection.
-
+
@library{wxbase}
@category{FIXME}
-
- @seealso
- wxDDEClient, wxDDEServer, @ref overview_ipcoverview "Interprocess
+
+ @see wxDDEClient, wxDDEServer, @ref overview_ipcoverview "Interprocess
communications overview"
*/
class wxDDEConnection : public wxObject
transactions.
*/
wxDDEConnection();
- wxDDEConnection(void* buffer, size_t size);
+ wxDDEConnection(void* buffer, size_t size);
//@}
//@{
*/
bool Advise(const wxString& item, const void* data, size_t size,
wxIPCFormat format = wxIPC_PRIVATE);
- bool Advise(const wxString& item, const char* data);
- bool Advise(const wxString& item, const wchar_t* data);
- bool Advise(const wxString& item, const wxString data);
+ bool Advise(const wxString& item, const char* data);
+ bool Advise(const wxString& item, const wchar_t* data);
+ bool Advise(const wxString& item, const wxString data);
//@}
/**
*/
bool Execute(const void* data, size_t size,
wxIPCFormat format = wxIPC_PRIVATE);
- bool Execute(const char* data);
- bool Execute(const wchar_t* data);
- bool Execute(const wxString data);
+ bool Execute(const char* data);
+ bool Execute(const wchar_t* data);
+ bool Execute(const wxString data);
//@}
/**
*/
virtual const void* OnRequest(const wxString& topic,
const wxString& item,
- size_t * size,
+ size_t* size,
wxIPCFormat format);
/**
*/
bool Poke(const wxString& item, const void* data, size_t size,
wxIPCFormat format = wxIPC_PRIVATE);
- bool Poke(const wxString& item, const char* data);
- bool Poke(const wxString& item, const wchar_t* data);
- bool Poke(const wxString& item, const wxString data);
+ bool Poke(const wxString& item, const char* data);
+ bool Poke(const wxString& item, const wchar_t* data);
+ bool Poke(const wxString& item, const wxString data);
//@}
/**
character string (actually a pointer to the connection's buffer) if
successful, @NULL otherwise.
*/
- const void* Request(const wxString& item, size_t * size,
+ const void* Request(const wxString& item, size_t* size,
wxIPCFormat format = wxIPC_TEXT);
/**
};
+
/**
@class wxDDEClient
@wxheader{dde.h}
-
+
A wxDDEClient object represents the client part of a client-server DDE
(Dynamic Data Exchange) conversation.
-
+
To create a client which can communicate with a suitable server,
you need to derive a class from wxDDEConnection and another from wxDDEClient.
The custom wxDDEConnection class will intercept communications in
a 'conversation' with a server, and the custom wxDDEServer is required
so that a user-overridden wxDDEClient::OnMakeConnection member can return
a wxDDEConnection of the required class, when a connection is made.
-
+
This DDE-based implementation is
available on Windows only, but a platform-independent, socket-based version
of this API is available using wxTCPClient.
-
+
@library{wxbase}
@category{FIXME}
-
- @seealso
- wxDDEServer, wxDDEConnection, @ref overview_ipcoverview "Interprocess
+
+ @see wxDDEServer, wxDDEConnection, @ref overview_ipcoverview "Interprocess
communications overview"
*/
class wxDDEClient : public wxObject
the OnMakeConnection() member to return your own
derived connection object.
*/
- wxConnectionBase * MakeConnection(const wxString& host,
- const wxString& service,
- const wxString& topic);
+ wxConnectionBase* MakeConnection(const wxString& host,
+ const wxString& service,
+ const wxString& topic);
/**
The type of wxDDEConnection returned from a MakeConnection() call can
be altered by deriving the @b OnMakeConnection member to return your
own derived connection object. By default, a wxDDEConnection
object is returned.
-
The advantage of deriving your own connection class is that it will
enable you to intercept messages initiated by the server, such
as wxDDEConnection::OnAdvise. You may also want to
store application-specific data in instances of the new class.
*/
- wxConnectionBase * OnMakeConnection();
+ wxConnectionBase* OnMakeConnection();
/**
Returns @true if this is a valid host name, @false otherwise. This always
};
+
/**
@class wxDDEServer
@wxheader{dde.h}
-
+
A wxDDEServer object represents the server part of a client-server DDE
(Dynamic Data Exchange) conversation.
-
+
This DDE-based implementation is
available on Windows only, but a platform-independent, socket-based version
of this API is available using wxTCPServer.
-
+
@library{wxbase}
@category{FIXME}
-
- @seealso
- wxDDEClient, wxDDEConnection, @ref overview_ipcoverview "IPC overview"
+
+ @see wxDDEClient, wxDDEConnection, @ref overview_ipcoverview "IPC overview"
*/
-class wxDDEServer
+class wxDDEServer
{
public:
/**
always sent for standard input and output, but in the context of DDE
messages it doesn't make a lot of sense.
*/
- virtual wxConnectionBase * OnAcceptConnection(const wxString& topic);
+ virtual wxConnectionBase* OnAcceptConnection(const wxString& topic);
};
+
// ============================================================================
// Global functions/macros
// ============================================================================
Called when wxWidgets exits, to clean up the DDE system. This no longer needs
to be
called by the application.
-
- See also wxDDEInitialize.
+ See also wxDDEInitialize().
*/
void wxDDECleanUp();
/**
Initializes the DDE system. May be called multiple times without harm.
-
This no longer needs to be called by the application: it will be called
by wxWidgets if necessary.
-
See also wxDDEServer, wxDDEClient, wxDDEConnection,
- wxDDECleanUp.
+ wxDDECleanUp().
*/
void wxDDEInitialize();
projects / wxWidgets.git / blobdiff