CCPrintDlg Class Reference

Base class for Print UI dialogs and pages. More...

#include <CCPrintDlg.h>

Inherited by CCLicenseLocationDlg, CCPrintProgressDlg, and CCPrintPropPage.

Public Member Functions
	CCPrintDlg (UINT uResourceID)
	Constructor.
virtual int	DoModal (HWND hParent)
	Runs the dialog.
Protected Member Functions
virtual BOOL	PageProc (UINT uMsg, WPARAM wParam, LPARAM lParam)
	Called when a windows message is sent to the page.
virtual void	PostDestroy ()
	Called after the last message was sent to the window and it is closed.
HWND	GetDlgItem (UINT uID)
	Returns the window handle of a control by the control ID.
void	EnableDlgItem (UINT uID, BOOL bEnable)
	Enables or disables a control by the control ID.
UINT	GetDlgItemText (UINT uID, LPTSTR lpString, int nMaxSize)
	Retrieves the text of a control in the dialog.
void	SetDlgItemText (UINT uID, LPCTSTR lpString)
	Sets the text of a control in the dialog.
BOOL	GetDlgItemCheck (UINT uID)
	Retrieves the check status of a check box control.
void	SetDlgItemCheck (UINT uID, BOOL bCheck)
	Sets or clears the check mark in a check box control.
int	GetCheckedRadioBtn (UINT uIDStart, UINT uIDEnd)
	Retrieves which radio button is selected in a range of radio button controls.
int	GetDlgComboCount (UINT uID)
	Retrieves the number of items in a combo box control.
int	GetDlgComboSel (UINT uID)
	Retrieves the index of the selected item in a combo box control (-1 if none selected).
LONG_PTR	GetDlgComboSelData (UINT uID)
	Retrieves the Data associated with the selected item in a combo box control (0 if none selected).
std::tstring	GetDlgComboText (UINT uID)
	Retrieves the text of the currently selected item of a combo box control.
void	SetDlgComboItem (UINT uID, int nItem)
	Sets the selection of a combo box control.
void	SetDlgComboSel (UINT uID, DWORD dwData)
	Sets the selection of a combo box control by the item's Data.
void	SetDlgComboSel (UINT uID, LPCTSTR lpString)
	Sets the selection of a combo box control by the item's text.
void	AddDlgComboString (UINT uID, UINT uStringID, DWORD dwData)
	Adds an item to a combo box control using a resource string.
void	AddDlgComboString (UINT uID, LPCTSTR lpString, DWORD dwData)
	Adds an item to a combo box control.
void	CleanDlgCombo (UINT uID)
	Removes all items from a combo box control.
int	MessageBox (LPCTSTR lpText, LPCTSTR lpCaption, UINT uType)
	Displays a message box.
void	SetWindowLong (int nIndex, LONG_PTR dwNewLong)
	Sets the value of one of the dialog box's Windows attributes; see SetWindowLong in MSDN for more information.
DWORD	GetWindowLong (int nIndex)
	Retrieves the value of one of the dialog box's Windows attributes; see GetWindowLong in MSDN for more information.
Static Protected Member Functions
static INT_PTR APIENTRY	StaticDlgProc (HWND hDlg, UINT uMsg, WPARAM wParam, LPARAM lParam)
	Called by Windows when the dialog box receives a windows message.
Protected Attributes
UINT	m_uResourceID
	Resource ID.
HWND	m_hDlg
	Handle of dialog (valid only while running).

Detailed Description

Base class for Print UI dialogs and pages.

Definition at line 35 of file CCPrintDlg.h.

Constructor & Destructor Documentation

CCPrintDlg::CCPrintDlg ( UINT uResourceID ) [inline]

Constructor.

Parameters:

uResourceID

Resource ID of the dialog or page

Definition at line 43 of file CCPrintDlg.h.

Member Function Documentation

void CCPrintDlg::AddDlgComboString	(	UINT	uID,
		LPCTSTR	lpString,
		DWORD	dwData
	)			`[protected]`

Adds an item to a combo box control.

Parameters:

	uID	ID of the combo box control to add the item to
	lpString	The text of the new item
	dwData	The data of the new item

Definition at line 362 of file CCPrintDlg.cpp.

References GetDlgItem().

void CCPrintDlg::AddDlgComboString	(	UINT	uID,
		UINT	uStringID,
		DWORD	dwData
	)			`[protected]`

Adds an item to a combo box control using a resource string.

Parameters:

	uID	ID of the combo box control to add the item to
	uStringID	Resource ID of the text string
	dwData	The data to set for the new item

Definition at line 345 of file CCPrintDlg.cpp.

References LoadResourceString(), and tstring.

Referenced by CCLicenseWizJurisdictionPage::OnSetActive(), and CCLicensePropPage::PageProc().

void CCPrintDlg::CleanDlgCombo ( UINT uID ) [protected]

Removes all items from a combo box control.

Parameters:

uID

ID of the combo box to clear

Definition at line 388 of file CCPrintDlg.cpp.

References GetDlgItem().

Referenced by CCLicenseWizJurisdictionPage::OnSetActive().

int CCPrintDlg::DoModal ( HWND hParent ) [virtual]

Runs the dialog.

Parameters:

hParent

Handle of parent window

Returns:: The exit code (see DialogBox in MSDN)

Reimplemented in CCPrintPropPage.

Definition at line 428 of file CCPrintDlg.cpp.

References ghInstance, m_uResourceID, and StaticDlgProc().

Referenced by CCPrintProgressDlg::DoRequest(), and CCLicensePropPage::PageProc().

void CCPrintDlg::EnableDlgItem	(	UINT	uID,
		BOOL	bEnable
	)			`[inline, protected]`

Enables or disables a control by the control ID.

Parameters:

	uID	The control ID
	bEnable	TRUE to enable the control, FALSE to disable it

Definition at line 79 of file CCPrintDlg.h.

References GetDlgItem().

Referenced by CCPDFPropPage::InitControls(), CCPrintProgressDlg::PageProc(), CCLicenseWizJurisdictionPage::UpdateControls(), and CCLicensePropPage::UpdateLicenseLocationControls().

int CCPrintDlg::GetCheckedRadioBtn	(	UINT	uIDStart,
		UINT	uIDEnd
	)			`[protected]`

Retrieves which radio button is selected in a range of radio button controls.

Parameters:

	uIDStart	ID of the first radio button control in the set
	uIDEnd	ID of the last radio button control in the set

Returns:: The number of the selected radio button (or -1 if none are selected)

Definition at line 407 of file CCPrintDlg.cpp.

References m_hDlg.

Referenced by CCLicenseWizUsagePage::OnKillActive(), CCLicenseWizSamplingPage::OnKillActive(), CCLicenseWizModificationPage::OnKillActive(), CCLicenseWizJurisdictionPage::OnKillActive(), CCLicenseWizTypePage::PageProc(), CCLicensePropPage::PageProc(), CCLicenseWizUsagePage::UpdateControls(), CCLicenseWizSamplingPage::UpdateControls(), CCLicenseWizModificationPage::UpdateControls(), and CCLicenseWizJurisdictionPage::UpdateControls().

int CCPrintDlg::GetDlgComboCount ( UINT uID ) [protected]

Retrieves the number of items in a combo box control.

Parameters:

uID

ID of the control to query

Returns:: The number of items in the control

Definition at line 131 of file CCPrintDlg.cpp.

References GetDlgItem().

Referenced by CCLicenseWizJurisdictionPage::UpdateControls().

int CCPrintDlg::GetDlgComboSel ( UINT uID ) [protected]

Retrieves the index of the selected item in a combo box control (-1 if none selected).

Parameters:

uID

ID of the control to query

Returns:

Definition at line 149 of file CCPrintDlg.cpp.

References GetDlgItem().

Referenced by CCLicenseWizJurisdictionPage::UpdateControls(), and CCLicensePropPage::UpdateLicenseLocationControls().

LONG_PTR CCPrintDlg::GetDlgComboSelData ( UINT uID ) [protected]

Retrieves the Data associated with the selected item in a combo box control (0 if none selected).

Parameters:

uID

ID of the control to query

Returns:: The data of the selected item (0 if not found)

Definition at line 167 of file CCPrintDlg.cpp.

References GetDlgItem().

Referenced by CCLicensePropPage::PageProc().

std::tstring CCPrintDlg::GetDlgComboText ( UINT uID ) [protected]

Retrieves the text of the currently selected item of a combo box control.

Parameters:

uID

ID of combo box control to query

Returns:: The text of the combo box

Definition at line 191 of file CCPrintDlg.cpp.

References GetDlgItem(), and tstring.

Referenced by CCLicenseWizJurisdictionPage::OnKillActive().

HWND CCPrintDlg::GetDlgItem ( UINT uID ) [inline, protected]

Returns the window handle of a control by the control ID.

Parameters:

uID

The control ID

Returns:: The window handle

Definition at line 73 of file CCPrintDlg.h.

References m_hDlg.

Referenced by AddDlgComboString(), CleanDlgCombo(), EnableDlgItem(), GetDlgComboCount(), GetDlgComboSel(), GetDlgComboSelData(), GetDlgComboText(), GetDlgItemCheck(), CCLicensePropPage::InitControls(), CCLicenseWizTypePage::OnSetActive(), CCLicenseWizSummeryPage::OnSetActive(), CCPrintProgressDlg::PageProc(), CCLicenseWizTypePage::PageProc(), CCLicensePropPage::PageProc(), CCLicenseLocationDlg::PageProc(), SetDlgComboItem(), SetDlgComboSel(), SetDlgItemCheck(), and CCLicensePropPage::UpdateLicenseControls().

BOOL CCPrintDlg::GetDlgItemCheck ( UINT uID ) [protected]

Retrieves the check status of a check box control.

Parameters:

uID

ID of control to check

Returns:: TRUE if the check box is checked, FALSE if it's cleared

Definition at line 95 of file CCPrintDlg.cpp.

References GetDlgItem().

Referenced by CCPDFPropPage::PageProc(), and CCLicensePropPage::PageProc().

UINT CCPrintDlg::GetDlgItemText	(	UINT	uID,
		LPTSTR	lpString,
		int	nMaxSize
	)			`[inline, protected]`

Retrieves the text of a control in the dialog.

Parameters:

	uID	The ID of the control
	lpString	String to put the text in
	nMaxSize	Length of the string

Returns:: The number of characters copied to the string, or 0 if failed

Definition at line 88 of file CCPrintDlg.h.

References m_hDlg.

Referenced by CCLicenseLocationDlg::UpdateXyTextboxes().

DWORD CCPrintDlg::GetWindowLong ( int nIndex ) [inline, protected]

Retrieves the value of one of the dialog box's Windows attributes; see GetWindowLong in MSDN for more information.

Parameters:

nIndex

The index of the attributes

Returns:: The value of the attribute

Definition at line 145 of file CCPrintDlg.h.

References m_hDlg.

Referenced by CCLicensePropPage::InitControls(), and StaticDlgProc().

int CCPrintDlg::MessageBox	(	LPCTSTR	lpText,
		LPCTSTR	lpCaption,
		UINT	uType
	)			`[inline, protected]`

Displays a message box.

Parameters:

	lpText	The message box text
	lpCaption	The message box caption
	uType	The message box type (buttons, icon)

Returns:: The return value (which button was pressed)

Definition at line 132 of file CCPrintDlg.h.

References m_hDlg.

Referenced by CCLicenseWizTypePage::OnKillActive().

BOOL CCPrintDlg::PageProc	(	UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam
	)			`[protected, virtual]`

Called when a windows message is sent to the page.

Parameters:

	uMsg	ID of the message
	wParam	First parameter of the message
	lParam	Second parameter of the message

Returns:: TRUE if handled, FALSE to continue handling the message

Reimplemented in CCLicenseLocationDlg, CCLicensePropPage, CCLicenseWizBasePage, CCLicenseWizJurisdictionPage, CCLicenseWizModificationPage, CCLicenseWizSamplingPage, CCLicenseWizTypePage, CCLicenseWizUsagePage, CCPDFPropPage, and CCPrintProgressDlg.

Definition at line 439 of file CCPrintDlg.cpp.

References m_hDlg.

Referenced by StaticDlgProc().

void CCPrintDlg::SetDlgComboItem	(	UINT	uID,
		int	nItem
	)			`[protected]`

Sets the selection of a combo box control.

Parameters:

	uID	ID of the combo box control to set
	nItem	Index of the item to select

Definition at line 234 of file CCPrintDlg.cpp.

References GetDlgItem().

Referenced by CCLicenseWizJurisdictionPage::UpdateControls().

void CCPrintDlg::SetDlgComboSel	(	UINT	uID,
		LPCTSTR	lpString
	)			`[protected]`

Sets the selection of a combo box control by the item's text.

Parameters:

	uID	ID of combo box control to set
	lpString	The text of the item to select

Definition at line 285 of file CCPrintDlg.cpp.

References GetDlgItem().

void CCPrintDlg::SetDlgComboSel	(	UINT	uID,
		DWORD	dwData
	)			`[protected]`

Sets the selection of a combo box control by the item's Data.

Parameters:

	uID	ID of the combo box control to set
	dwData	Data of the item to select

Definition at line 252 of file CCPrintDlg.cpp.

References GetDlgItem().

Referenced by CCLicenseWizJurisdictionPage::OnSetActive(), and CCLicensePropPage::UpdateLicenseLocationControls().

void CCPrintDlg::SetDlgItemCheck	(	UINT	uID,
		BOOL	bCheck
	)			`[protected]`

Sets or clears the check mark in a check box control.

Parameters:

	uID	ID of the control to set
	bCheck	TRUE to set the check mark, FALSE to clear it

Definition at line 113 of file CCPrintDlg.cpp.

References GetDlgItem().

Referenced by CCPDFPropPage::InitControls(), CCPDFPropPage::PageProc(), and CCLicensePropPage::UpdateLicenseLocationControls().

void CCPrintDlg::SetDlgItemText	(	UINT	uID,
		LPCTSTR	lpString
	)			`[inline, protected]`

Sets the text of a control in the dialog.

Parameters:

	uID	ID of the control
	lpString	The text to put in the control

Definition at line 94 of file CCPrintDlg.h.

References m_hDlg.

Referenced by CCLicenseWizSummeryPage::OnSetActive(), CCLicenseWizJurisdictionPage::OnSetActive(), CCLicenseWizTypePage::SetDescription(), CCLicenseWizBasePage::SetDescriptionFromField(), CCLicensePropPage::UpdateLicenseControls(), and CCLicenseLocationDlg::UpdateXyTextboxes().

void CCPrintDlg::SetWindowLong	(	int	nIndex,
		LONG_PTR	dwNewLong
	)			`[inline, protected]`

Sets the value of one of the dialog box's Windows attributes; see SetWindowLong in MSDN for more information.

Parameters:

	nIndex	The index of the attribute
	dwNewLong	The new value

Definition at line 139 of file CCPrintDlg.h.

References m_hDlg.

Referenced by CCLicensePropPage::InitControls(), CCLicenseWizBasePage::PageProc(), StaticDlgProc(), and CCPrintPropPage::StaticPageProc().

INT_PTR APIENTRY CCPrintDlg::StaticDlgProc	(	HWND	hDlg,
		UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam
	)			`[static, protected]`

Called by Windows when the dialog box receives a windows message.

Parameters:

	hDlg	Handle to the dialog
	uMsg	ID of the message
	wParam	First parameter of the message
	lParam	Second parameter of the message

Returns:: TRUE if handled, FALSE to continue handling the message

Definition at line 41 of file CCPrintDlg.cpp.

References GetWindowLong(), m_hDlg, PageProc(), PostDestroy(), and SetWindowLong().

Referenced by DoModal(), and CCPrintPropPage::StaticPageProc().

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

CCPrintUI/CCPrintDlg.h
CCPrintUI/CCPrintDlg.cpp

CCPrintDlg Class Reference

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation