LImageViewerCell::CheckTitlebarIcon

#include "ltwrappr.h"

L_INT LImageViewerCell::CheckTitlebarIcon(nSubCellIndex, nIconIndex, bCheck, uFlags)

L_INT nSubCellIndex;

/* index into the image list attached to the cell */

L_INT nIconIndex;

/* index of the title bar icon */

L_BOOL bCheck;

/* flag */

L_UINT uFlags;

/* reserved for future use */

Checks or unchecks the specific title bar icon of the specific cell or sub-cell.

Parameter

Description

nSubCellIndex

A zero-based index into the image list attached to the cell. This function will check or uncheck the title bar icon of this sub-cell. Pass -1 to apply this effect on all sub-cells. Pass -2 to apply this effect on the selected sub-cell.

nIconIndex

A zero-based index of the icon that the user needs to check or uncheck. Pass -1 to check or uncheck all icons of the specific sub-cell.

bCheck

Flag that indicates whether to check or uncheck the specific title bar icon. Possible values are:

 

Value

Meaning

 

TRUE

Check the specific title bar icon.

 

FALSE

Uncheck the specific title bar icon.

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To retrieve the status of a specific title bar icon whether it is checked or unchecked, call the LImageViewerCell::IsTitlebarIconChecked function.

Required DLLs and Libraries

LTIVW

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LImageViewer::Create, LImageViewer::Destroy, LImageViewerCell::IsTitlebarIconChecked, LImageViewerCell::GetTitlebarProperties, LImageViewerCell::IsTitlebarEnabled, LImageViewerCell::SetIconProperties, LImageViewerCell::GetIconProperties, LImageViewerCell::SetTitlebarProperties, LImageViewerCell::ShowTitlebar.

Topics:

Image Viewer Functions: The Title Bar Feature

 

The Title Bar Feature

Example

For an example, refer to LImageViewerCell::ShowTitlebar.