C++ Classes


	C++ Classes	Softel vdm, Inc.

Class

Description

CSftTabs

Tab control.

CSftTabsDialog

Tabbed dialog.

CSftTabsPage

Page of a tabbed dialog.

CSftTabsWindowSheet

Tabbed window.

CSftTabsWindowPage

Page of a tabbed window.

CSftTabs Class, Member Functions

CSftTabs is derived from CWnd.

Member	Description
AddTab	Adds a new tab to a tab control. The new tab will be added as the last tab.
AdjustClientRect	Calculates a tab control size which will provide a client area of the given size.
Create	Creates a tab control window and attaches it to the CSftTabs object.
CSftTabs	Standard constructor.
DeleteTab	Deletes a tab from the tab control.
GetAllowAllInactive	Enables all tabs to become inactive.
GetControlInfo	Retrieves tab control attributes.
GetCount	Retrieves the number of tabs in a tab control.
GetCtlColors	Returns the tab control's color attributes.
GetGDIPlusAvailable	Returns whether GDI+ support is available.
GetCurrentTab	Retrieves the index of the currently active tab.
GetNextTab	Retrieves the index of the next tab about to become active.
GetTabDialog	Retrieves the CSftTabsPage based object attached to the specified tab.
GetTabInfo	Retrieves tab attributes.
GetTabLabel	Retrieves a tab's text.
GetTabLabelLen	Retrieves the length of a tab's text.
GetTabWindowPage	Retrieves the CSftTabsWindowPage based object attached to the specified tab.
GetToolTip	Retrieves a tab's ToolTip text.
GetToolTipLen	Retrieves the length of a tab's ToolTip text.
GetVisibleCount	Retrieves the count of visible tabs.
HitTest	Determines the tab index of the tab at a given location.
InsertTab	Inserts a new tab at the specified position.
QueryChar	Tests if a tab control responds to the specified character, i.e. the character is an accelerator key which the tab control processes.
RegisterApp	Registers the application for use of SftTabs/DLL controls.
ResetContent	Removes all tabs from a tab control.
ResizePages	Resizes attached pages when using a frame window.
ScrollTabs	Scrolls tabs in the direction specified.
SetAllowAllInactive	Enables all tabs to become inactive.
SetControlInfo	Sets tab control attributes.
SetCtlColors	Sets the tab control's color attributes.
SetCurrentTab	Makes the specified tab the new active tab.
SetCurrentTabEx	Makes the specified tab the new active tab.
SetDrawTabCallback	Defines a drawing callback routine used to paint tab labels.
SetTabDialog	Sets the CSftTabsPage based object pointer attached to the specified tab.
SetTabInfo	Sets the tab attributes for the specified tab.
SetTabLabel	Sets a tab's text.
SetTabWindowPage	Sets the CSftTabsWindowPage based object pointer attached to the specified tab.
SetToolTip	Sets a tab's ToolTip text.
SetVersion	Sets the SftTabs/DLL version an application requires.
SwitchTab	Switches to the next/previous tab.
UnregisterApp	Unregisters the application.

CSftTabsDialog Class, Member Functions

The class CSftTabsDialog describes a main, tabbed dialog. A CSftTabsDialog based dialog is created using a dialog resource defined using a resource editor. A CSftTabsDialog based dialog contains at least one tab control (CSftTabs based) and optionally buttons, such as OK, Cancel, and other Windows controls.

CSftTabsDialog is derived from CDialog.

Member

Description

ClosePossible

Determines whether a tabbed dialog can be closed.

CSftTabsDialog

Standard constructor.

GetModified

Retrieves the current data modification flag for the tabbed dialog.

InitializeTabControl

Initializes a tab control in a tabbed dialog. Activates the specified tab and the associated page.

m_fInitializing

Defines the current initialization status.

m_fModified

Defines the current data modification status.

OnCancel

Called when the user hits the ESCAPE key or clicks the Cancel button (the button with an ID of IDCANCEL).

OnOK

Called when the user clicks the OK button (the button with an ID of IDOK).

SetClose

Signals that data has been changed permanently and the tabbed dialog can no longer be Cancel'ed.

SetModified

Sets the current data modification flag for the tabbed dialog.

CSftTabsPage Class, Member Functions

The class CSftTabsPage describes a dialog (called page) attached to a tab control, which is embedded in a CSftTabsDialog based dialog. A CSftTabsPage based dialog is created using a dialog resource defined using a resource editor. A CSftTabsPage based dialog contains Windows controls and may optionally also include a tab control with nested CSftTabsPage objects attached to the tab control.

CSftTabsPage is derived from CDialog.

Member

Description

AllowDestroy

Determines whether a page should be destroyed when it is no longer visible because the associated tab is no longer the currently active tab.

AllowSwitch

Determines whether a currently active page can be left and a new page activated.

ClosePossible

Determines whether a page can be closed.

CSftTabsPage

Standard constructor.

GetModified

Returns the current data modification flag for the tabbed dialog.

GetParentDialog

Returns the page's parent dialog object.

InitializeTabControl

Initializes a tab control in a page. Activates the specified tab and the associated page.

m_flagDrawBackground

Defines background handling for the tab page.

m_lpfnDrawBackground

Contains a pointer to the application supplied background handling callback for the tab page.

m_pTabCtl

Contains a pointer to the tab control object to which the page is attached.

m_UserDataBackground

Defines an application defined value that is passed to the background drawing callback CSftTabsPage::m_lpfnDrawBackground as the UserData parameter.

OnCancel

Called when the user clicks the Cancel button (the button with an ID of IDCANCEL).

OnOK

Called when the user clicks the OK button (the button with an ID of IDOK).

SetClose

Signals that data has been changed permanently and the tabbed dialog can no longer be Cancel'ed.

SetModified

Sets the current data modification flag for the tabbed dialog.

CSftTabsWindowSheet Class, Member Functions

The class CSftTabsWindowSheet describes the support necessary for a tabbed, main window. A tabbed window is usually created dynamically using the CWnd::Create function. A tabbed window contains at least one tab control (CSftTabs based) and optionally other Windows controls.

The class CSftTabsWindowSheet is used to add tabbed window support to most CWnd derived classes.

This is accomplished using multiple inheritance. You supply the CWnd derived class, and through multiple inheritance, the class can then be used as a tabbed window, containing one or more tab controls with attached pages.

Member

Description

ClosePossible

Determines whether a tabbed window can be closed.

CSftTabsWindowSheet

Standard constructor.

InitializeTabControl

Initializes a tab control in a tabbed window. Activates the specified tab and the associated page.

TabSwitched

Handles the SFTTABSN_SWITCHED notification.

TabSwitching

Handles the SFTTABSN_SWITCHING notification.

TerminateTabControl

Terminates a tab control and deactivates all pages.

CSftTabsWindowPage Class, Member Functions

The class CSftTabsWindowPage describes the support necessary for a window to be used as a page in a tabbed window. A CSftTabsWindowPage based window is typically created dynamically (at run-time) when the user switches to a tab.

The class CSftTabsWindowPage is used to add support to most CWnd derived classes so they can be used as pages in a tabbed window.

This is accomplished using multiple inheritance. You supply the CWnd derived class, and through multiple inheritance, the class can then be used as a page in a tabbed window.

Member

Description

ActivatePage

Creates or activates a page.

AllowSwitch

Determines whether a currently active page can be left and a new page activated.

CSftTabsWindowPage

Standard constructor.

DeactivatePage

Deactivates or destroys a page

Class	Description
CSftTabs	Tab control.
CSftTabsDialog	Tabbed dialog.
CSftTabsPage	Page of a tabbed dialog.
CSftTabsWindowSheet	Tabbed window.
CSftTabsWindowPage	Page of a tabbed window.

Member	Description
ClosePossible	Determines whether a tabbed dialog can be closed.
CSftTabsDialog	Standard constructor.
GetModified	Retrieves the current data modification flag for the tabbed dialog.
InitializeTabControl	Initializes a tab control in a tabbed dialog. Activates the specified tab and the associated page.
m_fInitializing	Defines the current initialization status.
m_fModified	Defines the current data modification status.
OnCancel	Called when the user hits the ESCAPE key or clicks the Cancel button (the button with an ID of IDCANCEL).
OnOK	Called when the user clicks the OK button (the button with an ID of IDOK).
SetClose	Signals that data has been changed permanently and the tabbed dialog can no longer be Cancel'ed.
SetModified	Sets the current data modification flag for the tabbed dialog.

Member	Description
AllowDestroy	Determines whether a page should be destroyed when it is no longer visible because the associated tab is no longer the currently active tab.
AllowSwitch	Determines whether a currently active page can be left and a new page activated.
ClosePossible	Determines whether a page can be closed.
CSftTabsPage	Standard constructor.
GetModified	Returns the current data modification flag for the tabbed dialog.
GetParentDialog	Returns the page's parent dialog object.
InitializeTabControl	Initializes a tab control in a page. Activates the specified tab and the associated page.
m_flagDrawBackground	Defines background handling for the tab page.
m_lpfnDrawBackground	Contains a pointer to the application supplied background handling callback for the tab page.
m_pTabCtl	Contains a pointer to the tab control object to which the page is attached.
m_UserDataBackground	Defines an application defined value that is passed to the background drawing callback CSftTabsPage::m_lpfnDrawBackground as the UserData parameter.
OnCancel	Called when the user clicks the Cancel button (the button with an ID of IDCANCEL).
OnOK	Called when the user clicks the OK button (the button with an ID of IDOK).
SetClose	Signals that data has been changed permanently and the tabbed dialog can no longer be Cancel'ed.
SetModified	Sets the current data modification flag for the tabbed dialog.

Member	Description
ActivatePage	Creates or activates a page.
AllowSwitch	Determines whether a currently active page can be left and a new page activated.
CSftTabsWindowPage	Standard constructor.
DeactivatePage	Deactivates or destroys a page