Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / ipcbase.h

diff --git a/include/wx/ipcbase.h b/include/wx/ipcbase.h
index 56de3c8d35fc720f595910d818e84f9218bb4007..521bef85951f5c672628553fd7f33b2bbb476925 100644 (file)
--- a/include/wx/ipcbase.h
+++ b/include/wx/ipcbase.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        ipcbase.h
+// Name:        wx/ipcbase.h

 // Purpose:     Base classes for IPC
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     Base classes for IPC
 // Author:      Julian Smart
 // Modified by:


@@ -72,7 +72,7 @@ public:
                                               : size, wxIPC_UNICODETEXT); }
   bool Execute(const wxString& s)
   {
                                               : size, wxIPC_UNICODETEXT); }
   bool Execute(const wxString& s)
   {

-      const wxUTF8Buf buf = s.utf8_str();
+      const wxScopedCharBuffer buf = s.utf8_str();

       return DoExecute(buf, strlen(buf) + 1, wxIPC_UTF8TEXT);
   }
   bool Execute(const wxCStrData& cs)
       return DoExecute(buf, strlen(buf) + 1, wxIPC_UTF8TEXT);
   }
   bool Execute(const wxCStrData& cs)


@@ -94,7 +94,7 @@ public:
                                        : size, wxIPC_UNICODETEXT); }
   bool Poke(const wxString& item, const wxString s)
   {
                                        : size, wxIPC_UNICODETEXT); }
   bool Poke(const wxString& item, const wxString s)
   {

-      const wxUTF8Buf buf = s.utf8_str();
+      const wxScopedCharBuffer buf = s.utf8_str();

       return DoPoke(item, buf,  strlen(buf) + 1, wxIPC_UTF8TEXT);
   }
   bool Poke(const wxString& item, const wxCStrData& cs)
       return DoPoke(item, buf,  strlen(buf) + 1, wxIPC_UTF8TEXT);
   }
   bool Poke(const wxString& item, const wxCStrData& cs)


@@ -116,7 +116,7 @@ public:
                                          : size, wxIPC_UNICODETEXT); }
   bool Advise(const wxString& item, const wxString s)
   {
                                          : size, wxIPC_UNICODETEXT); }
   bool Advise(const wxString& item, const wxString s)
   {

-      const wxUTF8Buf buf = s.utf8_str();
+      const wxScopedCharBuffer buf = s.utf8_str();

       return DoAdvise(item, buf,  strlen(buf) + 1, wxIPC_UTF8TEXT);
   }
   bool Advise(const wxString& item, const wxCStrData& cs)
       return DoAdvise(item, buf,  strlen(buf) + 1, wxIPC_UTF8TEXT);
   }
   bool Advise(const wxString& item, const wxCStrData& cs)


@@ -129,7 +129,14 @@ public:
   // Callbacks to SERVER - override at will
   virtual bool OnExec(const wxString& WXUNUSED(topic),
                       const wxString& WXUNUSED(data))
   // Callbacks to SERVER - override at will
   virtual bool OnExec(const wxString& WXUNUSED(topic),
                       const wxString& WXUNUSED(data))

-      { return false; }
+  {
+      wxFAIL_MSG( "This method shouldn't be called, if it is, it probably "
+                  "means that you didn't update your old code overriding "
+                  "OnExecute() to use the new parameter types (\"const void *\" "
+                  "instead of \"wxChar *\" and \"size_t\" instead of \"int\"), "
+                  "you must do it or your code wouldn't be executed at all!" );
+      return false;
+  }

 
   // deprecated function kept for backwards compatibility: usually you will
   // want to override OnExec() above instead which receives its data in a more
 
   // deprecated function kept for backwards compatibility: usually you will
   // want to override OnExec() above instead which receives its data in a more


@@ -173,10 +180,21 @@ public:
   virtual bool OnDisconnect() { delete this; return true; }
 
 
   virtual bool OnDisconnect() { delete this; return true; }
 
 

+  // return true if this is one of the formats used for textual data
+  // transmission
+  static bool IsTextFormat(wxIPCFormat format)
+  {
+      return format == wxIPC_TEXT ||
+             format == wxIPC_UTF8TEXT ||
+             format == wxIPC_UTF16TEXT ||
+             format == wxIPC_UTF32TEXT;
+  }
+

   // converts from the data and format into a wxString automatically
   //
   // this function accepts data in all of wxIPC_TEXT, wxIPC_UNICODETEXT, and
   // converts from the data and format into a wxString automatically
   //
   // this function accepts data in all of wxIPC_TEXT, wxIPC_UNICODETEXT, and

-  // wxIPC_UTF8TEXT formats but asserts if the format is anything else
+  // wxIPC_UTF8TEXT formats but asserts if the format is anything else (i.e.
+  // such that IsTextFormat(format) doesn't return true)

   //
   // notice that the size parameter here contains the total size of the data,
   // including the terminating '\0' or L'\0'
   //
   // notice that the size parameter here contains the total size of the data,
   // including the terminating '\0' or L'\0'


@@ -204,7 +222,7 @@ private:
 protected:
   bool          m_connected;
 
 protected:
   bool          m_connected;
 

-  DECLARE_NO_ASSIGN_CLASS(wxConnectionBase)
+  wxDECLARE_NO_ASSIGN_CLASS(wxConnectionBase);

   DECLARE_CLASS(wxConnectionBase)
 };
 
   DECLARE_CLASS(wxConnectionBase)
 };