OWLNext    7.0
Borland's Object Windows Library for the modern age
Loading...
Searching...
No Matches
owl::TModule Class Reference

ObjectWindows dynamic-link libraries (DLLs) construct an instance of TModule, which acts as an object-oriented stand-in for the library (DLL) module. More...

#include <owl/module.h>

Inheritance diagram for owl::TModule:
owl::TStreamableBase owl::TApplication owl::THtmlHelpDll owl::TMailer owl::TRichEditModule owl::TThemeModule owl::TWinSockDll

Public Types

typedef HINSTANCE THandle
 TModule encapsulates an HINSTANCE.
 

Public Member Functions

 TModule (const tstring &name, bool shouldLoad=true, bool mustLoad=true, bool addToList=true)
 Constructs a TModule object that is used as an alias for a DLL.
 
 TModule (LPCTSTR name, THandle handle, bool addToList=true)
 Constructs a TModule object that is an alias for an already loaded DLL or program with an available HInstance.
 
 TModule (const tstring &name, THandle handle, bool addToList=true)
 String-aware overload.
 
 TModule (LPCTSTR name, THandle handle, const tstring &cmdLine, bool addToList=true)
 Constructs a TModule object for an ObjectWindows DLL or program from within LibMain or WinMain.
 
 TModule (const tstring &name, THandle handle, const tstring &cmdLine, bool addToList=true)
 String-aware overload.
 
virtual ~TModule ()
 Destructs a TModule, freeing the instance if appropriate, and deleting new'd strings.
 
void InitModule (THandle handle, const tstring &cmdLine)
 Finish-up initialization of a module.
 
virtual int Error (TXBase &x, uint captionResId, uint promptResId=0)
 Replaceable exception handler; may be redefined to process OWL exceptions if canResume is false, then the user doesn't have the option of ignoring.
 
Get & set members. Use these instead of directly accessing members
LPCTSTR GetName () const
 Returns the name of the module.
 
void SetName (LPCTSTR name)
 Accessor function that sets the name of the module.
 
void SetName (const tstring &name)
 String-aware overload.
 
THandle GetHandle () const
 Return the instance handle of the library module represented by the TModule obect.
 
 operator THandle () const
 Returns the handle of the application or DLL module represented by this TModule.
 
bool operator== (const TModule &m) const
 Returns true if this instance is equal to the other instance; otherwise, returns false.
 
bool IsLoaded () const
 Returns a nonzero value if the instance handle is loaded.
 
Windows HINSTANCE/HMODULE related API functions encapsulated
int GetModuleFileName (TCHAR *buff, int maxChars) const
 Returns the expanded file name (path and file name) of the file from which this module was loaded.
 
tstring GetModuleFileName () const
 String-aware overload.
 
FARPROC GetProcAddress (TNarrowResId) const
 Returns the entry-point address of the specified exported function if found, otherwise returns NULL.
 
HRSRC FindResource (TResId id, TResId type) const
 Wrapper for the Windows API to find a particular resource.
 
HRSRC FindResourceEx (TResId id, TResId type, TLangId langId=LangNeutral) const
 Wrapper for the Windows API to find a particular resource.
 
HGLOBAL LoadResource (HRSRC hRsrc) const
 Wrapper for the Windows API.
 
uint32 SizeofResource (HRSRC hRsrc) const
 Wrapper for the Windows API.
 
int LoadString (uint id, TCHAR *buf, int maxChars) const
 Loads a string resource identified by id into the buffer pointed to by buff.
 
tstring LoadString (uint id) const
 Loads a string resource identified by id.
 
HBITMAP LoadBitmap (TResId id) const
 Wrapper for the Windows API.
 
HACCEL LoadAccelerators (TResId id) const
 Wrapper for the Windows API.
 
HMENU LoadMenu (TResId id) const
 Wrapper for the Windows API.
 
HCURSOR LoadCursor (TResId id) const
 Wrapper for the Windows API.
 
HICON LoadIcon (TResId name) const
 Wrapper for the Windows API.
 
std::string LoadHtml (TResId) const
 Loads the given HTML resource and returns it as a narrow string.
 
HICON CopyIcon (HICON hIcon) const
 Wrapper for the Windows API.
 
auto GetClassInfo (TWindowClassName, WNDCLASS *wndclass) const -> bool
 Retrieves information about the given window class.
 
auto GetClassInfo (TWindowClassName) const -> WNDCLASS
 Functional-style overload.
 
auto IsRegisteredClass (TWindowClassName) const -> bool
 Returns true if the given window class has been registered.
 
- Public Member Functions inherited from owl::TStreamableBase
virtual ~TStreamableBase ()
 

Static Public Member Functions

Global search for resources
static TModuleFindResModule (TResId id, TResId type)
 Global search for resources.
 
static TModuleNextModule (TModule *module=nullptr)
 

Protected Member Functions

void SetHandle (THandle handle)
 Set the module instance handle.
 

Friends

std::ostream & operator<< (std::ostream &os, const TModule &m)
 

Detailed Description

ObjectWindows dynamic-link libraries (DLLs) construct an instance of TModule, which acts as an object-oriented stand-in for the library (DLL) module.

Acts as an object-oriented stand-in for an application or library (DLL) module.

TModule defines behavior shared by both library and application modules. ObjectWindows applications construct an instance of TApplication, derived from TModule. TModule's constructors manage loading and freeing of external DLLs, and the member functions provide support for default error handling.

TModule defines behavior shared by both library and application modules. ObjectWindows

Definition at line 75 of file module.h.


The documentation for this class was generated from the following files: