X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..628e155d8c70da0f962289cf1e1dea3699255707:/interface/dde.h diff --git a/interface/dde.h b/interface/dde.h index 214aaa217a..520508906b 100644 --- a/interface/dde.h +++ b/interface/dde.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dde.h -// Purpose: documentation for wxDDEConnection class +// Purpose: interface of wxDDEConnection // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxDDEClient, wxDDEServer, @ref overview_ipcoverview "Interprocess + @see wxDDEClient, wxDDEServer, @ref overview_ipcoverview "Interprocess communications overview" */ class wxDDEConnection : public wxObject @@ -137,7 +136,7 @@ public: */ virtual const void* OnRequest(const wxString& topic, const wxString& item, - size_t * size, + size_t* size, wxIPCFormat format); /** @@ -177,7 +176,7 @@ public: 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); /** @@ -197,6 +196,7 @@ public: }; + /** @class wxDDEClient @wxheader{dde.h} @@ -218,8 +218,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxDDEServer, wxDDEConnection, @ref overview_ipcoverview "Interprocess + @see wxDDEServer, wxDDEConnection, @ref overview_ipcoverview "Interprocess communications overview" */ class wxDDEClient : public wxObject @@ -239,22 +238,21 @@ public: 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 @@ -264,6 +262,7 @@ public: }; + /** @class wxDDEServer @wxheader{dde.h} @@ -278,8 +277,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxDDEClient, wxDDEConnection, @ref overview_ipcoverview "IPC overview" + @see wxDDEClient, wxDDEConnection, @ref overview_ipcoverview "IPC overview" */ class wxDDEServer { @@ -307,31 +305,39 @@ 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 // ============================================================================ +/** @ingroup group_funcmacro_misc */ +//@{ + /** - Called when wxWidgets exits, to clean up the DDE system. This no longer needs - to be - called by the application. + Called when wxWidgets exits, to clean up the DDE system. This no longer + needs to be called by the application. - See also wxDDEInitialize. + @see wxDDEInitialize() + + @header{wx/dde.h} */ 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. + This no longer needs to be called by the application: it will be called by + wxWidgets if necessary. + + @see wxDDEServer, wxDDEClient, wxDDEConnection, wxDDECleanUp() - See also wxDDEServer, wxDDEClient, wxDDEConnection, - wxDDECleanUp. + @header{wx/dde.h} */ void wxDDEInitialize(); +//@} +