Description


Include file: xcontinf.h

Overview

XContainerInfo is a class to set/query general attributes for a XContainerControl. To make changes to the settings:

  1. query the current setting via XContainerControl::GetInfo()
  2. make the changes in the used instance of XContainerInfo
  3. call XContainerControl::SetInfo() with the used instance of XContainerInfo

Functions

XContainerInfo

Parameters

char * theTitle The title of the container. Default is empty.
LONG theStyle style of the container. Valid styles are:
CO_TEXT the container is in text-mode
CO_NAME the container is in name-mode
CO_ICON the container is in icon-mode
CO_DETAIL the container is in detail-mode
CO_FLOW arrange objects dynamicaly (text and name mode only)
CO_MINI the container use small icons
CO_TREE the container is in tree-mode
CO_OWNERPAINTBACKGROUND the owner will draw the background (see XBackgroundDrawEvent and XBackgroundDrawHandler)
CO_TREELINE draw the tree-line in tree-mode
CO_DRAWBITMAP draw icons
CO_DRAWICON draw bitmaps
CO_TITLE show the container-title
CO_TITLELEFT title is left-justified
CO_TITLERIGHT title is right-justified
CO_TITLECENTER title is centered
CO_TITLESEPARATOR the title is drawn with a separator
CO_TITLEREADONLY the title cannot been edited by the user
CO_DETAILTITLES in detail-mode the titles of XContainerColumn are shown

The attributes can be or-ed
Default is CO_ICON.

Remarks

Constructor of XContainerInfo

EnableSorting

Parameters

BOOL sort Set TRUE if the container items should be sorted when they are inserted. Therefor you must override the method XContainerObject::Sort. Default is TRUE.

Remarks

Enables sorting records when they are inserted.

GetBitmapSize

Parameters

XSize * size buffer to hold the size

Remarks

Query the size of bitmaps/icons

GetObjectCount

Return-Value

LONG objectCount

Remarks

Query the count of objects in the container.

SetBitmapSize

Parameters

XSize * size

Remarks

Set the size of bitmaps/icons

SetCollapsedBitmap

Parameters

XIcon * the new icon
XBitmap * the new bitmap

Remarks

Replace the collapsed-icon.
Replace the collapsed-bitmap.

SetExpandedBitmap

Parameters

XIcon * the new icon
XBitmap * the new bitmap

Remarks

Replace the expanded-icon.
Replace the expanded-bitmap.

SetSpacing

Parameters

SHORT spacing (in pixels)

Remarks

Set the vertical spacing between two objects.

SetTreeBitmapSize

Parameters

XSize * size

Remarks

Set the size of the expanded and collapsed bitmaps/icons in tree-view

SetTreeLineSpacing

Parameters

SHORT width (in pixels)

Remarks

Set the horizontal spacing between two levels in tree-view.

SetTreeLineWidth

Parameters

SHORT width (in pixels)

Remarks

Set the width of the trees line in tree-view.

EnableBackgroundPainting

Parameters

BOOL enable TRUE=enable, FALSE=disable

Remarks

Enable/disable background drawing by the application. To draw the background you must install a XBackgroundDrawHandler

IsBackgroundPaintingEnabled

Return-Value

BOOL result

Remarks

Query if owner-draw for the background is enabled or not.

SetAttributes

Parameters

LONG newAttributes attributes how the container should be displayed ( see XContainerInfo() )

Remarks

Specify here how the container should be displayed. After you have set up the XContainerInfo use XContainerColumn::SetInfo()

GetAttributes

Return-Value

LONG theAttributes the attributes which are set for the container (can be or-ed). See XContainerInfo()

Remarks

Query the attributes of the container.

GetTitle

Parameters

XString * theTitleBuffer here the title will be stored

Remarks

Query the containers title

SetTitle

Parameters

char * theTitle

Remarks

Set the title of the container.

GetSplitbarPos

Return-Value

LONG the position in window-pixels

Remarks

Query the position of the splitbar of a container.

SetSplitbarColumn

Parameters

XContainerColumn * theColumn the XContainerColumn after that the splitbar will be displayed

Remarks

Set a splitbar in a container.

SetSplitbarPos

Parameters

LONG position the position in window-pixels

Remarks

Set the position of the splitbar of a container.


This document was generated by Jens von Pilgrim's Autodoc