Detailed Description

Classes
class	Exception
	WinUI base exception class. More...

class	Win32Exception
	Base Win32 exception class. More...

struct	Font
	Wrapper around a Win32 Font. More...

struct	Rect
	Wrapper around a Win32 RECT. More...

class	SolidBrush
	Solid Brush wrapper. More...

class	DC
	Device context (DC) wrapper. More...

class	Bitmap

class	DIB
	DIB wrapper. More...

class	ImageList
	Image list wrapper. More...

class	Registry
	Registry access. More...

class	Clipboard
	Clipboard wrapper. More...

class	Menu
	Menu wrapper. More...

class	OpenFile
	Wrapper around the open common dialog. More...

class	SaveFile
	Wrapper around the save common dialog. More...

class	BrowseForFolder
	Wrapper around SHBrowseForFolder() More...

class	BaseWindow
	Base window class for Dialog and Window. More...

struct	MENUOrID
	Works around the menu / control ID problem in CreateWindow() More...

class	Window
	Window wrapper class. More...

class	Dialog
	Dialog wrapper class. More...

class	StatusBar
	Status bar control wrapper. More...

class	FrameWindow
	Frame window wrapper class. More...

class	ReBar
	ReBar control wrapper class. More...

class	ToolBar
	Tool bar control wrapper. More...

class	TabControl
	Tab control wrapper. More...

class	ClipboardViewer
	Clipboard viewer class. More...

class	Splitter
	Splitter window control. More...

class	Static
	Static control wrapper. More...

class	Button
	Button control wrapper. More...

class	Radio
	Radio button wrapper. More...

class	ComboBox
	Combo box control wrapper. More...

class	Header
	List view control wrapper. More...

class	ListBox
	List view control wrapper. More...

class	TreeView
	Tree view control wrapper. More...

class	ProgressBar
	Progress bar control wrapper. More...

class	Slider
	Slider bar control wrapper. More...

class	Edit
	Edit control wrapper. More...

class	RichEdit
	Rich edit control wrapper. More...

class	App
	WinUI application base class. More...

struct	RegVal

struct	cRegVal

struct	cReg

class	cAboutDlg

Macros
#define	WINUI_VERSION
	Revision of the WinUI library. Check for this to avoid version conflicts. More...

#define	WINUI_INL
	WinUI inline mode. All global functions as well as some class members cary this attribute. More...

#define	WINUI_RELEASE(x)
	Enable or exclude threading support and related classes. More...

#define	WINUI_INITSTRUCT(x)
	Zeroes out a Win32 struct and sets the dwSize member. More...

#define	WINUI_SIGNED_LOWORD(L)
	Like the Win32 LOWORD macro, but for signed numbers. More...

#define	WINUI_SIGNED_HIWORD(L)
	Like the Win32 HIWORD macro, but for signed numbers. More...

#define	WINUI_NORM_RAND
	Returns a random number between 0 and 1. More...

#define	WINUI_CLAMP(Num, Min, Max)
	Clamps the value Num to the range (Min, Max) More...

#define	WINUI_SAFE_DEL(x)
	Deletes a pointer. More...

#define	WINUI_SAFE_DEL_ARR(x)
	Deletes an array. More...

#define	WINUI_INIT_CONTROL(var, ID)

#define	WINUI_ADD_RADIO_STATE(var, ID)

#define	WINUI_BEGIN_WND_MSG_MAP()

#define	WINUI_END_WND_MSG_MAP(__base)

#define	WINUI_BEGIN_DLG_MSG_MAP()

#define	WINUI_END_DLG_MSG_MAP(__base)

#define	WINUI_BEGIN_NOTIFY_HANDLER()

#define	WINUI_END_NOTIFY_HANDLER()

#define	WINUI_BEGIN_COMMAND_HANDLER()

#define	WINUI_END_COMMAND_HANDLER()

#define	WINUI_COMMAND_BEGIN_CTRL_HANDLER()

#define	WINUI_COMMAND_CTRL_HANLDER(__id, __handler)

#define	WINUI_COMMAND_END_CTRL_HANDLER()

#define	WINUI_COMMAND_BEGIN_MENU_HANDLER()

#define	WINUI_COMMAND_MENU_HANLDER(__id, __handler)

#define	WINUI_COMMAND_END_MENU_HANDLER()

#define	WINUI_COMMAND_BEGIN_ACCEL_HANDLER()

#define	WINUI_COMMAND_ACCEL_HANLDER(__id, __handler)

#define	WINUI_COMMAND_END_ACCEL_HANDLER()

#define	WINUI_MESSAGE_HANDLER(__message, __handler)

#define	WINUI_NOTIFY_HANDLER(__wmId, __handler)

#define	WINUI_NOTIFY_HANDLER_EX(__wmId, __handler)

#define	WINUI_COMMAND_OKCANCEL_HANDLERS()

#define	WINUI_COMMAND_OK_HANDLER()

#define	WINUI_COMMAND_CANCEL_HANDLER()

#define	WINUI_DBG_BREAK
	Triggers a user breakpoint. More...

#define	WINUI_VERIFY(x)

#define	WINUI_THROW(ExceptionInstance, ExceptionType)
	Calls Throw() with the file / line parameters filled. More...

#define	WINUI_CHECK_LAST_ERR
	Calls CheckLastErr with the correct file and line parameters. More...

#define	WINUI_CREATE_DLL_VERSION(Major, Minor)
	Creates DLL version DWORD. More...

#define	WINUI_DEF_WND_CLS
	Default window class. More...

#define	WINUI_DECLARE(AppDerivedType)
	Declares WinMain() and instantiates an App derived type. More...

Enumerations
enum	OSType { eWindows95, eWindows95_OSR2, eWindows98, eWindows98_SE, eWindowsME, eWindowsNT351, eWindowsNT4, eWindowsNT4_SP6, eWindows2000, eWindows2000_SP1, eWindows2000_SP2, eWindows2000_SP3_OrGreater, eWindowsXP_Beta, eWindowsXP, eWindowsXP_SP1_OrGreater, eWindowsNETServer, eUnknownOS_NT }
	Contains constants for all Win32 systems. More...

Functions
BOOL	SendMessageW (HWND hWnd, UINT Msg, WPARAM wParam, LPARAM lParam)

BOOL	PostMessage (HWND hWnd, UINT Msg, WPARAM wParam, LPARAM lParam)

template<class TException >
WINUI_INL void	Throw (TException &cException, const TCHAR *pszFile, int iLine)
	Throws Exception derived exception classes. More...

WINUI_INL ni::cString	FormatLastWin32Err ()
	Returns error string for the last Win32 error. More...

WINUI_INL void	CheckLastErr (const TCHAR *pszFile, int iLine)
	Calls GetLastError() to determine if the last API call failed. Displays an error message dialog box in the case of failure. More...

WINUI_INL const TCHAR *	GetModulePath ()
	Returns the path of the physical file the running module is implemented. More...

WINUI_INL ni::cString	LoadString (UINT id)

WINUI_INL OSType	GetOS ()
	Determines the installed OS. More...

WINUI_INL bool	IsOSNT ()
	Determines if the installed OS is based on the NT kernel. More...

WINUI_INL DWORD	AverageRGBA (DWORD dwCol1, DWORD dwCol2)
	Computes '(Col1 + Col2) / 2' with two 0xRRGGBBAA colors. More...

WINUI_INL DWORD	GetDllVersion (const TCHAR *pszDLLName)
	Obtains version information from a DLL. More...

WINUI_INL LONG	GetFileSize (const TCHAR *pszFileName)
	Obtains the size of a file. More...

WINUI_INL LRESULT CALLBACK	GlobalWndProc (HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
	Global message procedure for all Window derived classes. More...

WINUI_INL LPCTSTR	RegisterClass (const TCHAR *pszName, UINT iStyle=CS_HREDRAW\|CS_VREDRAW, LPCTSTR pszIconRes=NULL, LPCTSTR pszSmIconRes=NULL, HBRUSH hbrBackground=NULL)
	Window class registration function. More...

WINUI_INL LRESULT CALLBACK	GlobalDlgProc (HWND hWndDialog, UINT uMsg, WPARAM wParam, LPARAM lParam)
	Global message procedure for all Dialog derived classes. More...

WINUI_INL BOOL	InitCommonControls ()
	Inititalize common controls. More...

WINUI_INL BOOL	Initialize ()
	Main initialization function. More...

WINUI_INL int	MainLoop (HACCEL hAccelerators=NULL, HWND hWndAccel=NULL)
	Call to process messages until WM_QUIT is being received. More...

WINUI_INL void	MainLoopPeek (HACCEL hAccelerators=NULL, HWND hWndAccel=NULL)
	Call to process all queued messages. More...

void	RegValInit (RegVal *pValData)

void	RegValFree (RegVal *pValData)

bool	RegValGetNumber (const RegVal pValData, DWORD pdwNumber)

bool	RegValGetBinary (const RegVal *pValData, LPBYTE pbyteData, DWORD dwSize)

bool	RegValGetNewBinary (const RegVal pValData, LPBYTE pbyteData, DWORD *pdwSize)

bool	RegValGetNewString (const RegVal pValData, LPTSTR pszString, DWORD *pdwLength)

bool	RegValGetString (const RegVal *pValData, LPTSTR pszString, DWORD dwLength)

bool	RegValGetStringArr (const RegVal *pValData, LPTSTR pszStrings[], DWORD dwCount)

bool	RegValGetNewStringArr (const RegVal pValData, LPTSTR pszStrings, DWORD pdwCount)

void	RegValSetNumber (RegVal *pValData, DWORD dwNumber)

bool	RegValSetBinary (RegVal *pValData, const LPBYTE pbyteData, DWORD dwSize)

bool	RegValSetString (RegVal *pValData, LPCTSTR pszString)

bool	RegValSetStringArr (RegVal *pValData, const LPCTSTR pszStrings[], DWORD dwCount)

HKEY	RegConnect (HKEY hKey, LPCTSTR pszRemote)

HKEY	RegOpen (HKEY hKey, LPCTSTR pszSubKey, DWORD dwRights)

HKEY	RegCreate (HKEY hKey, LPCTSTR pszSubKey, DWORD dwRights)

void	RegClose (HKEY hKey)

bool	RegLoadVal (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, RegVal *pValData)

bool	RegLoadNumber (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, DWORD *pdwNumber)

bool	RegLoadBinary (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, LPBYTE pbyteData, DWORD dwSize)

bool	RegLoadNewBinary (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, LPBYTE pbyteData, DWORD pdwSize)

bool	RegLoadString (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, LPTSTR pszString, DWORD dwLength)

bool	RegLoadNewString (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, LPTSTR pszString, DWORD pdwLength)

bool	RegLoadStringArr (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, LPTSTR pszStrings[], DWORD dwCount)

bool	RegLoadNewStringArr (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, LPTSTR *pszStrings, DWORD pdwCount)

bool	RegSaveVal (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, const RegVal *pValData)

bool	RegSaveNumber (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, DWORD dwNumber)

bool	RegSaveBinary (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, const LPBYTE pbyteData, DWORD dwSize)

bool	RegSaveString (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, LPCTSTR pszString)

bool	RegSaveStringArr (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName, const LPCTSTR pszStrings[], DWORD dwCount)

bool	RegDeleteSubKeys (HKEY hKey)

bool	RegDeleteKey (HKEY hKey, LPCTSTR pszSubKey, LPCTSTR pszValName)

bool	RegHasEntries (HKEY hKey, LPCTSTR pszSubKey, DWORD pdwSubKeyCount, DWORD pdwValueCount)

BOOL	SetClassesRootRegKey (const ni::achar lpszKey, const ni::achar lpszValue, const ni::achar *lpszValueName=NULL)

const ni::achar *	RegisterApp (const ni::achar aszAppName, const ni::achar aszExt, const ni::achar *aszDocDesc)

	cRegVal ()

	~cRegVal ()

void	Init ()

void	Free ()

bool	GetNumber (DWORD *pdwNumber) const

bool	GetBinary (LPBYTE pbyteData, DWORD dwSize) const

bool	GetNewBinary (LPBYTE pbyteData, DWORD pdwSize) const

bool	GetString (LPTSTR pszString, DWORD dwLength) const

bool	GetNewString (LPTSTR pszString, DWORD pdwLength) const

bool	GetStringArr (LPTSTR pszStrings[], DWORD dwCount) const

bool	GetNewStringArr (LPTSTR *pszStrings, DWORD pdwCount) const

void	SetNumber (DWORD dwNumber)

bool	SetBinary (const LPBYTE pbyteData, DWORD dwSize)

bool	SetString (LPCTSTR pszString)

bool	SetStringArr (const LPCTSTR pszStrings[], DWORD dwCount)

	cReg ()

	~cReg ()

HKEY	Connect (HKEY hNewKey, LPCTSTR pszRemote)

HKEY	Open (HKEY hNewKey=NULL)

HKEY	Open (HKEY hNewKey, LPCTSTR pszSubKey, DWORD dwRights)

void	Close ()

HKEY	Create (HKEY hNewKey, LPCTSTR pszSubKey, DWORD dwRights)

bool	LoadVal (LPCTSTR pszValName, RegVal *pValData)

bool	LoadVal (LPCTSTR pszSubKey, LPCTSTR pszValName, RegVal *pValData)

bool	LoadNumber (LPCTSTR pszValName, DWORD *pdwNumber)

bool	LoadNumber (LPCTSTR pszSubKey, LPCTSTR pszValName, DWORD *pdwNumber)

bool	LoadBinary (LPCTSTR pszValName, LPBYTE pbyteData, DWORD dwSize)

bool	LoadBinary (LPCTSTR pszSubKey, LPCTSTR pszValName, LPBYTE pbyteData, DWORD dwSize)

bool	LoadNewBinary (LPCTSTR pszValName, LPBYTE pbyteData, DWORD pdwSize)

bool	LoadNewBinary (LPCTSTR pszSubKey, LPCTSTR pszValName, LPBYTE pbyteData, DWORD pdwSize)

bool	LoadString (LPCTSTR pszValName, LPTSTR pszString, DWORD dwLength)

bool	LoadString (LPCTSTR pszSubKey, LPCTSTR pszValName, LPTSTR pszString, DWORD dwLength)

bool	LoadNewString (LPCTSTR pszValName, LPTSTR pszString, DWORD pdwLength)

bool	LoadNewString (LPCTSTR pszSubKey, LPCTSTR pszValName, LPTSTR pszString, DWORD pdwLength)

bool	LoadStringArr (LPCTSTR pszValName, LPTSTR pszStrings[], DWORD dwCount)

bool	LoadStringArr (LPCTSTR pszSubKey, LPCTSTR pszValName, LPTSTR pszStrings[], DWORD dwCount)

bool	LoadNewStringArr (LPCTSTR pszValName, LPTSTR *pszStrings, DWORD pdwCount)

bool	LoadNewStringArr (LPCTSTR pszSubKey, LPCTSTR pszValName, LPTSTR *pszStrings, DWORD pdwCount)

bool	LoadString (LPCTSTR pszValName, ni::cString &sString)

bool	LoadString (LPCTSTR pszSubKey, LPCTSTR pszValName, ni::cString &sString)

bool	SaveVal (LPCTSTR pszValName, const RegVal *pValData)

bool	SaveVal (LPCTSTR pszSubKey, LPCTSTR pszValName, const RegVal *pValData)

bool	SaveNumber (LPCTSTR pszValName, DWORD dwNumber)

bool	SaveNumber (LPCTSTR pszSubKey, LPCTSTR pszValName, DWORD dwNumber)

bool	SaveBinary (LPCTSTR pszValName, const LPBYTE pbyteData, DWORD dwSize)

bool	SaveBinary (LPCTSTR pszSubKey, LPCTSTR pszValName, const LPBYTE pbyteData, DWORD dwSize)

bool	SaveString (LPCTSTR pszValName, LPCTSTR pszString)

bool	SaveString (LPCTSTR pszSubKey, LPCTSTR pszValName, LPCTSTR pszString)

bool	SaveStringArr (LPCTSTR pszValName, const LPCTSTR pszStrings[], DWORD dwCount)

bool	SaveStringArr (LPCTSTR pszSubKey, LPCTSTR pszValName, const LPCTSTR pszStrings[], DWORD dwCount)

bool	DeleteKey (LPCTSTR pszValName)

bool	DeleteKey (LPCTSTR pszSubKey, LPCTSTR pszValName)

bool	DeleteSubKeys ()

bool	HasEntries (DWORD pdwSubKeyCount, DWORD pdwValueCount)

bool	HasEntries (LPCTSTR pszSubKey, DWORD pdwSubKeyCount, DWORD pdwValueCount)

Macro Definition Documentation

#define WINUI_VERSION

Revision of the WinUI library. Check for this to avoid version conflicts.

#define WINUI_INL

WinUI inline mode. All global functions as well as some class members cary this attribute.

#define WINUI_RELEASE ( x )

Enable or exclude threading support and related classes.

Releases an IUnknown interface or general class having a Release() method

#define WINUI_INITSTRUCT ( x )

Zeroes out a Win32 struct and sets the dwSize member.

#define WINUI_SIGNED_LOWORD ( L )

Like the Win32 LOWORD macro, but for signed numbers.

#define WINUI_SIGNED_HIWORD ( L )

Like the Win32 HIWORD macro, but for signed numbers.

#define WINUI_NORM_RAND

Returns a random number between 0 and 1.

#define WINUI_CLAMP	(	Num,
		Min,
		Max
	)

Clamps the value Num to the range (Min, Max)

#define WINUI_SAFE_DEL ( x )

Deletes a pointer.

#define WINUI_SAFE_DEL_ARR ( x )

Deletes an array.

#define WINUI_INIT_CONTROL	(	var,
		ID
	)

#define WINUI_ADD_RADIO_STATE	(	var,
		ID
	)

#define WINUI_BEGIN_WND_MSG_MAP ( )

#define WINUI_END_WND_MSG_MAP ( __base )

#define WINUI_BEGIN_DLG_MSG_MAP ( )

#define WINUI_END_DLG_MSG_MAP ( __base )

#define WINUI_BEGIN_NOTIFY_HANDLER ( )

#define WINUI_END_NOTIFY_HANDLER ( )

#define WINUI_BEGIN_COMMAND_HANDLER ( )

#define WINUI_END_COMMAND_HANDLER ( )

#define WINUI_COMMAND_BEGIN_CTRL_HANDLER ( )

#define WINUI_COMMAND_CTRL_HANLDER	(	__id,
		__handler
	)

#define WINUI_COMMAND_END_CTRL_HANDLER ( )

#define WINUI_COMMAND_BEGIN_MENU_HANDLER ( )

#define WINUI_COMMAND_MENU_HANLDER	(	__id,
		__handler
	)

#define WINUI_COMMAND_END_MENU_HANDLER ( )

#define WINUI_COMMAND_BEGIN_ACCEL_HANDLER ( )

#define WINUI_COMMAND_ACCEL_HANLDER	(	__id,
		__handler
	)

#define WINUI_COMMAND_END_ACCEL_HANDLER ( )

#define WINUI_MESSAGE_HANDLER	(	__message,
		__handler
	)

#define WINUI_NOTIFY_HANDLER	(	__wmId,
		__handler
	)

#define WINUI_NOTIFY_HANDLER_EX	(	__wmId,
		__handler
	)

#define WINUI_COMMAND_OKCANCEL_HANDLERS ( )

#define WINUI_COMMAND_OK_HANDLER ( )

#define WINUI_COMMAND_CANCEL_HANDLER ( )

#define WINUI_DBG_BREAK

Triggers a user breakpoint.

#define WINUI_VERIFY ( x )

#define WINUI_THROW	(	ExceptionInstance,
		ExceptionType
	)

Calls Throw() with the file / line parameters filled.

See also: Throw()

#define WINUI_CHECK_LAST_ERR

Calls CheckLastErr with the correct file and line parameters.

See also: CheckLastErr()

#define WINUI_CREATE_DLL_VERSION	(	Major,
		Minor
	)

Creates DLL version DWORD.

See also: GetDllVersion()

#define WINUI_DEF_WND_CLS

Default window class.

See also: Window

#define WINUI_DECLARE ( AppDerivedType )

Declares WinMain() and instantiates an App derived type.

Parameters

AppDerivedType custom App derived class of you application

Remarks: If the macro is not used, the applications needs to provide its own WinMain() and call Initialize() manually

See also: App, Initialize()

Enumeration Type Documentation

enum OSType

Contains constants for all Win32 systems.

See also: GetOS()

Enumerator
eWindows95
eWindows95_OSR2
eWindows98
eWindows98_SE
eWindowsME
eWindowsNT351
eWindowsNT4
eWindowsNT4_SP6
eWindows2000
eWindows2000_SP1
eWindows2000_SP2
eWindows2000_SP3_OrGreater
eWindowsXP_Beta
eWindowsXP
eWindowsXP_SP1_OrGreater
eWindowsNETServer
eUnknownOS_NT

Function Documentation

BOOL WinUI::SendMessageW	(	HWND	hWnd,
		UINT	Msg,
		WPARAM	wParam,
		LPARAM	lParam
	)

BOOL WinUI::PostMessage	(	HWND	hWnd,
		UINT	Msg,
		WPARAM	wParam,
		LPARAM	lParam
	)

WINUI_INL void WinUI::Throw	(	TException &	cException,
		const TCHAR *	pszFile,
		int	iLine
	)

Throws Exception derived exception classes.

Remarks: Macro WINUI_THROW fills in last two parameters automatically

See also: Exception, WINUI_THROW

WINUI_INL ni::cString WinUI::FormatLastWin32Err ( )

Returns error string for the last Win32 error.

WINUI_INL void WinUI::CheckLastErr	(	const TCHAR *	pszFile,
		int	iLine
	)

Calls GetLastError() to determine if the last API call failed. Displays an error message dialog box in the case of failure.

Parameters

pszFile	Source file where function os being called from
iLine	Source line where function os being called from

See also: WINUI_CHECK_LAST_ERR, FormatLastWin32Err()

WINUI_INL const TCHAR* WinUI::GetModulePath ( )

Returns the path of the physical file the running module is implemented.

Remarks: Uses static variable, not thread safe

Returns: File path and name

WINUI_INL ni::cString WinUI::LoadString ( UINT id )

WINUI_INL OSType WinUI::GetOS ( )

Determines the installed OS.

Returns: Constant describing the installed OS

See also: OSType, IsOSNT()

WINUI_INL bool WinUI::IsOSNT ( )

Determines if the installed OS is based on the NT kernel.

Returns: true if OS is NT based

See also: GetOS()

WINUI_INL DWORD WinUI::AverageRGBA	(	DWORD	dwCol1,
		DWORD	dwCol2
	)

Computes '(Col1 + Col2) / 2' with two 0xRRGGBBAA colors.

WINUI_INL DWORD WinUI::GetDllVersion ( const TCHAR * pszDLLName )

Obtains version information from a DLL.

Returns: DWORD version, use WINUI_CREATE_DLL_VERSION to create value for compare

See also: WINUI_CREATE_DLL_VERSION

WINUI_INL LONG WinUI::GetFileSize ( const TCHAR * pszFileName )

Obtains the size of a file.

WINUI_INL LRESULT CALLBACK WinUI::GlobalWndProc	(	HWND	hWnd,
		UINT	message,
		WPARAM	wParam,
		LPARAM	lParam
	)

Global message procedure for all Window derived classes.

See also: Window, WINUI_BEGIN_MSG_MAP

WINUI_INL LPCTSTR WinUI::RegisterClass	(	const TCHAR *	pszName,
		UINT	iStyle = `CS_HREDRAW \| CS_VREDRAW`,
		LPCTSTR	pszIconRes = `NULL`,
		LPCTSTR	pszSmIconRes = `NULL`,
		HBRUSH	hbrBackground = `NULL`
	)

Window class registration function.

Returns: NULL in case of failure

See also: Window

WINUI_INL LRESULT CALLBACK GlobalDlgProc	(	HWND	hWndDialog,
		UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam
	)

Global message procedure for all Dialog derived classes.

See also: Dialog, WINUI_DLG_BEGIN_MSG_MAP

WINUI_INL BOOL WinUI::InitCommonControls ( )

Inititalize common controls.

Returns: TRUE in case of success

Remarks: Automatically called by Initialize()

See also: Initialize()

WINUI_INL BOOL WinUI::Initialize ( )

Main initialization function.

Returns: TRUE in case of success

Remarks: Automatically called by WINUI_DECLARE

See also: WINUI_DECLARE

WINUI_INL int WinUI::MainLoop	(	HACCEL	hAccelerators = `NULL`,
		HWND	hWndAccel = `NULL`
	)

Call to process messages until WM_QUIT is being received.

See also: MainLoopPeek()

Parameters

hAccelerators	Accelerator table which should be used
hWndAccel	Handle to the window whose messages are to be translated

WINUI_INL void WinUI::MainLoopPeek	(	HACCEL	hAccelerators = `NULL`,
		HWND	hWndAccel = `NULL`
	)

Call to process all queued messages.

See also: MainLoop()

Parameters

hAccelerators	Accelerator table which should be used
hWndAccel	Handle to the window whose messages are to be translated

void WinUI::RegValInit ( RegVal * pValData )

void WinUI::RegValFree ( RegVal * pValData )

bool WinUI::RegValGetNumber	(	const RegVal *	pValData,
		DWORD *	pdwNumber
	)

bool WinUI::RegValGetBinary	(	const RegVal *	pValData,
		LPBYTE	pbyteData,
		DWORD	dwSize
	)

bool WinUI::RegValGetNewBinary	(	const RegVal *	pValData,
		LPBYTE *	pbyteData,
		DWORD *	pdwSize
	)

bool WinUI::RegValGetNewString	(	const RegVal *	pValData,
		LPTSTR *	pszString,
		DWORD *	pdwLength
	)

bool WinUI::RegValGetString	(	const RegVal *	pValData,
		LPTSTR	pszString,
		DWORD	dwLength
	)

bool WinUI::RegValGetStringArr	(	const RegVal *	pValData,
		LPTSTR	pszStrings[],
		DWORD	dwCount
	)

bool WinUI::RegValGetNewStringArr	(	const RegVal *	pValData,
		LPTSTR **	pszStrings,
		DWORD *	pdwCount
	)

void WinUI::RegValSetNumber	(	RegVal *	pValData,
		DWORD	dwNumber
	)

bool WinUI::RegValSetBinary	(	RegVal *	pValData,
		const LPBYTE	pbyteData,
		DWORD	dwSize
	)

bool WinUI::RegValSetString	(	RegVal *	pValData,
		LPCTSTR	pszString
	)

bool WinUI::RegValSetStringArr	(	RegVal *	pValData,
		const LPCTSTR	pszStrings[],
		DWORD	dwCount
	)

HKEY WinUI::RegConnect	(	HKEY	hKey,
		LPCTSTR	pszRemote
	)

HKEY WinUI::RegOpen	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		DWORD	dwRights
	)

HKEY WinUI::RegCreate	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		DWORD	dwRights
	)

void WinUI::RegClose ( HKEY hKey )

bool WinUI::RegLoadVal	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		RegVal *	pValData
	)

bool WinUI::RegLoadNumber	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		DWORD *	pdwNumber
	)

bool WinUI::RegLoadBinary	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPBYTE	pbyteData,
		DWORD	dwSize
	)

bool WinUI::RegLoadNewBinary	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPBYTE *	pbyteData,
		DWORD *	pdwSize
	)

bool WinUI::RegLoadString	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPTSTR	pszString,
		DWORD	dwLength
	)

bool WinUI::RegLoadNewString	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPTSTR *	pszString,
		DWORD *	pdwLength
	)

bool WinUI::RegLoadStringArr	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPTSTR	pszStrings[],
		DWORD	dwCount
	)

bool WinUI::RegLoadNewStringArr	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPTSTR **	pszStrings,
		DWORD *	pdwCount
	)

bool WinUI::RegSaveVal	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		const RegVal *	pValData
	)

bool WinUI::RegSaveNumber	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		DWORD	dwNumber
	)

bool WinUI::RegSaveBinary	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		const LPBYTE	pbyteData,
		DWORD	dwSize
	)

bool WinUI::RegSaveString	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPCTSTR	pszString
	)

bool WinUI::RegSaveStringArr	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		const LPCTSTR	pszStrings[],
		DWORD	dwCount
	)

bool WinUI::RegDeleteSubKeys ( HKEY hKey )

bool WinUI::RegDeleteKey	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		LPCTSTR	pszValName
	)

bool WinUI::RegHasEntries	(	HKEY	hKey,
		LPCTSTR	pszSubKey,
		DWORD *	pdwSubKeyCount,
		DWORD *	pdwValueCount
	)

BOOL WinUI::SetClassesRootRegKey	(	const ni::achar *	lpszKey,
		const ni::achar *	lpszValue,
		const ni::achar *	lpszValueName = `NULL`
	)

const ni::achar* WinUI::RegisterApp	(	const ni::achar *	aszAppName,
		const ni::achar *	aszExt,
		const ni::achar *	aszDocDesc
	)

cRegVal ( )

~cRegVal ( )

void Init ( )

void Free ( )

bool GetNumber ( DWORD * pdwNumber ) const

bool GetBinary	(	LPBYTE	pbyteData,
		DWORD	dwSize
	)		const

bool GetNewBinary	(	LPBYTE *	pbyteData,
		DWORD *	pdwSize
	)		const

bool GetString	(	LPTSTR	pszString,
		DWORD	dwLength
	)		const

bool GetNewString	(	LPTSTR *	pszString,
		DWORD *	pdwLength
	)		const

bool GetStringArr	(	LPTSTR	pszStrings[],
		DWORD	dwCount
	)		const

bool GetNewStringArr	(	LPTSTR **	pszStrings,
		DWORD *	pdwCount
	)		const

void SetNumber ( DWORD dwNumber )

bool SetBinary	(	const LPBYTE	pbyteData,
		DWORD	dwSize
	)

bool SetString ( LPCTSTR pszString )

bool SetStringArr	(	const LPCTSTR	pszStrings[],
		DWORD	dwCount
	)

cReg ( )

~cReg ( )

HKEY Connect	(	HKEY	hNewKey,
		LPCTSTR	pszRemote
	)

HKEY Open ( HKEY hNewKey = NULL )

HKEY Open	(	HKEY	hNewKey,
		LPCTSTR	pszSubKey,
		DWORD	dwRights
	)

void Close ( )

HKEY Create	(	HKEY	hNewKey,
		LPCTSTR	pszSubKey,
		DWORD	dwRights
	)

bool LoadVal	(	LPCTSTR	pszValName,
		RegVal *	pValData
	)

bool LoadVal	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		RegVal *	pValData
	)

bool LoadNumber	(	LPCTSTR	pszValName,
		DWORD *	pdwNumber
	)

bool LoadNumber	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		DWORD *	pdwNumber
	)

bool LoadBinary	(	LPCTSTR	pszValName,
		LPBYTE	pbyteData,
		DWORD	dwSize
	)

bool LoadBinary	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPBYTE	pbyteData,
		DWORD	dwSize
	)

bool LoadNewBinary	(	LPCTSTR	pszValName,
		LPBYTE *	pbyteData,
		DWORD *	pdwSize
	)

bool LoadNewBinary	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPBYTE *	pbyteData,
		DWORD *	pdwSize
	)

bool LoadString	(	LPCTSTR	pszValName,
		LPTSTR	pszString,
		DWORD	dwLength
	)

bool LoadString	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPTSTR	pszString,
		DWORD	dwLength
	)

bool LoadNewString	(	LPCTSTR	pszValName,
		LPTSTR *	pszString,
		DWORD *	pdwLength
	)

bool LoadNewString	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPTSTR *	pszString,
		DWORD *	pdwLength
	)

bool LoadStringArr	(	LPCTSTR	pszValName,
		LPTSTR	pszStrings[],
		DWORD	dwCount
	)

bool LoadStringArr	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPTSTR	pszStrings[],
		DWORD	dwCount
	)

bool LoadNewStringArr	(	LPCTSTR	pszValName,
		LPTSTR **	pszStrings,
		DWORD *	pdwCount
	)

bool LoadNewStringArr	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPTSTR **	pszStrings,
		DWORD *	pdwCount
	)

bool LoadString	(	LPCTSTR	pszValName,
		ni::cString &	sString
	)

bool LoadString	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		ni::cString &	sString
	)

bool SaveVal	(	LPCTSTR	pszValName,
		const RegVal *	pValData
	)

bool SaveVal	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		const RegVal *	pValData
	)

bool SaveNumber	(	LPCTSTR	pszValName,
		DWORD	dwNumber
	)

bool SaveNumber	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		DWORD	dwNumber
	)

bool SaveBinary	(	LPCTSTR	pszValName,
		const LPBYTE	pbyteData,
		DWORD	dwSize
	)

bool SaveBinary	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		const LPBYTE	pbyteData,
		DWORD	dwSize
	)

bool SaveString	(	LPCTSTR	pszValName,
		LPCTSTR	pszString
	)

bool SaveString	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		LPCTSTR	pszString
	)

bool SaveStringArr	(	LPCTSTR	pszValName,
		const LPCTSTR	pszStrings[],
		DWORD	dwCount
	)

bool SaveStringArr	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName,
		const LPCTSTR	pszStrings[],
		DWORD	dwCount
	)

bool DeleteKey ( LPCTSTR pszValName )

bool DeleteKey	(	LPCTSTR	pszSubKey,
		LPCTSTR	pszValName
	)

bool DeleteSubKeys ( )

bool HasEntries	(	DWORD *	pdwSubKeyCount,
		DWORD *	pdwValueCount
	)

bool HasEntries	(	LPCTSTR	pszSubKey,
		DWORD *	pdwSubKeyCount,
		DWORD *	pdwValueCount
	)

Detailed Description

Classes

Macros

Enumerations

Functions

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation