]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/dde.h
It was not acceptable to call the class method from the static initializer
[wxWidgets.git] / include / wx / msw / dde.h
CommitLineData
2bda0e17
KB
1/////////////////////////////////////////////////////////////////////////////
2// Name: dde.h
3// Purpose: DDE class
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
bbcdf8bc 8// Copyright: (c) Julian Smart
b814b812 9// Licence: wxWindows licence
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
bbcdf8bc
JS
12#ifndef _WX_DDE_H_
13#define _WX_DDE_H_
2bda0e17
KB
14
15#ifdef __GNUG__
16#pragma interface "dde.h"
17#endif
18
19#include "wx/ipcbase.h"
20
21/*
22 * Mini-DDE implementation
23
24 Most transactions involve a topic name and an item name (choose these
25 as befits your application).
26
27 A client can:
28
29 - ask the server to execute commands (data) associated with a topic
30 - request data from server by topic and item
31 - poke data into the server
32 - ask the server to start an advice loop on topic/item
33 - ask the server to stop an advice loop
34
35 A server can:
36
37 - respond to execute, request, poke and advice start/stop
38 - send advise data to client
39
40 Note that this limits the server in the ways it can send data to the
41 client, i.e. it can't send unsolicited information.
42 *
43 */
44
bddd7a8d
VZ
45class WXDLLIMPEXP_BASE wxDDEServer;
46class WXDLLIMPEXP_BASE wxDDEClient;
2bda0e17 47
bddd7a8d 48class WXDLLIMPEXP_BASE wxDDEConnection: public wxConnectionBase
2bda0e17
KB
49{
50 DECLARE_DYNAMIC_CLASS(wxDDEConnection)
b3324be2 51public:
d38e8d5f 52 wxDDEConnection(wxChar *buffer, int size); // use external buffer
b814b812 53 wxDDEConnection(); // use internal buffer
2bda0e17
KB
54 ~wxDDEConnection(void);
55
56 // Calls that CLIENT can make
e90c1d2a 57 virtual bool Execute(const wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
d38e8d5f 58 virtual wxChar *Request(const wxString& item, int *size = NULL, wxIPCFormat format = wxIPC_TEXT);
32c1cda2 59 virtual bool Poke(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
2bda0e17
KB
60 virtual bool StartAdvise(const wxString& item);
61 virtual bool StopAdvise(const wxString& item);
62
63 // Calls that SERVER can make
32c1cda2 64 virtual bool Advise(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
2bda0e17
KB
65
66 // Calls that both can make
67 virtual bool Disconnect(void);
68
2bda0e17
KB
69 // Default behaviour is to delete connection and return TRUE
70 virtual bool OnDisconnect(void);
b3324be2
JS
71
72 public:
b3324be2 73 wxString m_topicName;
b3324be2
JS
74 wxDDEServer* m_server;
75 wxDDEClient* m_client;
76
77 WXHCONV m_hConv;
32c1cda2 78 wxChar* m_sendingData;
b3324be2 79 int m_dataSize;
0d2a2b60 80 wxIPCFormat m_dataType;
22f3361e
VZ
81
82 DECLARE_NO_COPY_CLASS(wxDDEConnection)
2bda0e17
KB
83};
84
bddd7a8d 85class WXDLLIMPEXP_BASE wxDDEServer: public wxServerBase
2bda0e17
KB
86{
87 DECLARE_DYNAMIC_CLASS(wxDDEServer)
88 public:
89
90 wxDDEServer(void);
91 ~wxDDEServer(void);
92 bool Create(const wxString& server_name); // Returns FALSE if can't create server (e.g. port
93 // number is already in use)
94 virtual wxConnectionBase *OnAcceptConnection(const wxString& topic);
95
96 ////////////////////////////////////////////////////////////
97 // Implementation
98
99 // Find/delete wxDDEConnection corresponding to the HCONV
100 wxDDEConnection *FindConnection(WXHCONV conv);
101 bool DeleteConnection(WXHCONV conv);
b3324be2 102 inline wxString& GetServiceName(void) const { return (wxString&) m_serviceName; }
d162a7ee
VZ
103 inline wxDDEConnectionList& GetConnections(void) const
104 {
105 return (wxDDEConnectionList&) m_connections;
106 }
107
108protected:
109 int m_lastError;
110 wxString m_serviceName;
111 wxDDEConnectionList m_connections;
2bda0e17
KB
112};
113
bddd7a8d 114class WXDLLIMPEXP_BASE wxDDEClient: public wxClientBase
2bda0e17
KB
115{
116 DECLARE_DYNAMIC_CLASS(wxDDEClient)
117 public:
118 wxDDEClient(void);
119 ~wxDDEClient(void);
120 bool ValidHost(const wxString& host);
121 virtual wxConnectionBase *MakeConnection(const wxString& host, const wxString& server, const wxString& topic);
122 // Call this to make a connection.
123 // Returns NULL if cannot.
124 virtual wxConnectionBase *OnMakeConnection(void); // Tailor this to return own connection.
125
126 ////////////////////////////////////////////////////////////
127 // Implementation
128
129 // Find/delete wxDDEConnection corresponding to the HCONV
130 wxDDEConnection *FindConnection(WXHCONV conv);
131 bool DeleteConnection(WXHCONV conv);
2bda0e17 132
d162a7ee
VZ
133 inline wxDDEConnectionList& GetConnections(void) const
134 {
135 return (wxDDEConnectionList&) m_connections;
136 }
137
138protected:
139 int m_lastError;
140 wxDDEConnectionList m_connections;
2bda0e17
KB
141};
142
bddd7a8d
VZ
143void WXDLLIMPEXP_BASE wxDDEInitialize();
144void WXDLLIMPEXP_BASE wxDDECleanUp();
2bda0e17 145
2bda0e17 146#endif
bbcdf8bc 147 // _WX_DDE_H_