Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h
index 3ac5dfa24c248b0cfbc37cf3e9523f1719fd239f..142516f956ab6e2291706d889006067e0e4f0178 100644 (file)
--- a/include/wx/dynlib.h
+++ b/include/wx/dynlib.h
@@ -19,14 +19,6 @@
 #include "wx/string.h"
 #include "wx/dynarray.h"
 
-#if defined(__OS2__) || defined(__EMX__)
-#include "wx/os2/private.h"
-#endif
-
-#ifdef __WXMSW__
-#include "wx/msw/private.h"
-#endif
-
 // note that we have our own dlerror() implementation under Darwin
 #if (defined(HAVE_DLERROR) && !defined(__EMX__)) || defined(__DARWIN__)
     #define wxHAVE_DYNLIB_ERROR
@@ -41,7 +33,7 @@ class WXDLLIMPEXP_FWD_BASE wxDynamicLibraryDetailsCreator;
 // Note: __OS2__/EMX has to be tested first, since we want to use
 // native version, even if configure detected presence of DLOPEN.
 #if defined(__OS2__) || defined(__EMX__) || defined(__WINDOWS__)
-    typedef HMODULE             wxDllType;
+    typedef WXHMODULE           wxDllType;
 #elif defined(__DARWIN__)
     // Don't include dlfcn.h on Darwin, we may be using our own replacements.
     typedef void               *wxDllType;
@@ -116,7 +108,7 @@ enum wxPluginCategory
 // type only once, as the first parameter, and creating a variable of this type
 // called "pfn<name>" initialized with the "name" from the "dynlib"
 #define wxDYNLIB_FUNCTION(type, name, dynlib) \
-    type pfn ## name = (type)(dynlib).GetSymbol(_T(#name))
+    type pfn ## name = (type)(dynlib).GetSymbol(wxT(#name))
 
 
 // a more convenient function replacing wxDYNLIB_FUNCTION above
@@ -131,14 +123,14 @@ enum wxPluginCategory
 #define wxDL_INIT_FUNC(pfx, name, dynlib) \
     pfx ## name = (name ## _t)(dynlib).RawGetSymbol(#name)
 
-#ifdef __WXMSW__
+#ifdef __WINDOWS__
 
 // same as wxDL_INIT_FUNC() but appends 'A' or 'W' to the function name, see
 // wxDynamicLibrary::GetSymbolAorW()
 #define wxDL_INIT_FUNC_AW(pfx, name, dynlib) \
     pfx ## name = (name ## _t)(dynlib).GetSymbolAorW(#name)
 
-#endif // __WXMSW__
+#endif // __WINDOWS__
 
 // the following macros can be used to redirect a whole library to a class and
 // check at run-time if the library is present and contains all required
@@ -240,7 +232,7 @@ public:
     static wxDllType         GetProgramHandle();
 
     // return the platform standard DLL extension (with leading dot)
-    static const wxString& GetDllExt() { return ms_dllext; }
+    static wxString GetDllExt(wxDynamicLibraryCategory cat = wxDL_LIBRARY);
 
     wxDynamicLibrary() : m_handle(0) { }
     wxDynamicLibrary(const wxString& libname, int flags = wxDL_DEFAULT)
@@ -312,7 +304,7 @@ public:
 #endif
     }
 
-#ifdef __WXMSW__
+#ifdef __WINDOWS__
     // this function is useful for loading functions from the standard Windows
     // DLLs: such functions have an 'A' (in ANSI build) or 'W' (in Unicode, or
     // wide character build) suffix if they take string parameters
@@ -334,7 +326,7 @@ public:
     {
         return RawGetSymbolAorW(m_handle, name);
     }
-#endif // __WXMSW__
+#endif // __WINDOWS__
 
     // return all modules/shared libraries in the address space of this process
     //
@@ -357,6 +349,19 @@ public:
     static wxString GetPluginsDirectory();
 
 
+#ifdef __WINDOWS__
+    // return the handle (HMODULE/HINSTANCE) of the DLL with the given name
+    // and/or containing the specified address: for XP and later systems only
+    // the address is used and the name is ignored but for the previous systems
+    // only the name (which may be either a full path to the DLL or just its
+    // base name, possibly even without extension) is used
+    //
+    // the returned handle reference count is not incremented so it doesn't
+    // need to be freed using FreeLibrary() but it also means that it can
+    // become invalid if the DLL is unloaded
+    static WXHMODULE MSWGetModuleHandle(const wxString& name, void *addr);
+#endif // __WINDOWS__
+
 protected:
     // common part of GetSymbol() and HasSymbol()
     void *DoGetSymbol(const wxString& name, bool *success = 0) const;
@@ -367,9 +372,6 @@ protected:
 #endif // wxHAVE_DYNLIB_ERROR
 
 
-    // platform specific shared lib suffix.
-    static const wxString ms_dllext;
-
     // the handle to DLL or NULL
     wxDllType m_handle;
 
@@ -378,7 +380,7 @@ protected:
     wxDECLARE_NO_COPY_CLASS(wxDynamicLibrary);
 };
 
-#ifdef __WXMSW__
+#ifdef __WINDOWS__
 
 // ----------------------------------------------------------------------------
 // wxLoadedDLL is a MSW-only internal helper class allowing to dynamically bind
@@ -399,7 +401,7 @@ public:
     }
 };
 
-#endif // __WXMSW__
+#endif // __WINDOWS__
 
 // ----------------------------------------------------------------------------
 // Interesting defines