TimoSoft TabStrip  1.5.2.141
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Pages
TabStripCtlLibU Namespace Reference

Contains COM definitions for the control's public interface More...

Classes

struct  RECTANGLE
 Holds the coordinates of a rectangle's opposing corners More...
interface  IVirtualTabStripTab
 Wraps a not existing tab More...
interface  ITabStripTab
 Wraps an existing tab More...
interface  ITabStripTabs
 Manages a collection of TabStripTab objects More...
interface  ITabStripTabContainer
 Manages a collection of TabStripTab objects More...
interface  IOLEDataObject
 Wraps the IDataObject interface More...
interface  ITabStrip
 The main interface More...
interface  _ITabStripEvents
 The TabStrip class' events interface More...
class  TabStrip
 The TabStrip class More...
interface  _IVirtualTabStripTabEvents
 The VirtualTabStripTab class' events interface More...
class  VirtualTabStripTab
 The VirtualTabStripTab class More...
interface  _ITabStripTabEvents
 The TabStripTab class' events interface More...
class  TabStripTab
 The TabStripTab class More...
interface  _ITabStripTabsEvents
 The TabStripTabs class' events interface More...
class  TabStripTabs
 The TabStripTabs class More...
interface  _ITabStripTabContainerEvents
 The TabStripTabContainer class' events interface More...
class  TabStripTabContainer
 The TabStripTabContainer class More...
interface  _IOLEDataObjectEvents
 The OLEDataObject class' events interface More...
class  OLEDataObject
 The OLEDataObject class More...

Typedefs

typedef enum
TabStripCtlLibU::AppearanceConstants 
AppearanceConstants
 Constants used with the Appearance property
typedef enum
TabStripCtlLibU::BorderStyleConstants 
BorderStyleConstants
 Constants used with the BorderStyle property
typedef enum
TabStripCtlLibU::DisabledEventsConstants 
DisabledEventsConstants
 Flags used with the DisabledEvents property
typedef enum
TabStripCtlLibU::DropDescriptionIconConstants 
DropDescriptionIconConstants
 Constants used with the IOLEDataObject::GetDropDescription and IOLEDataObject::SetDropDescription methods
typedef enum
TabStripCtlLibU::FilteredPropertyConstants 
FilteredPropertyConstants
 Constants used with the ITabStripTabs::Filter property
typedef enum
TabStripCtlLibU::FilterTypeConstants 
FilterTypeConstants
 Constants used with the ITabStripTabs::FilterType property
typedef enum
TabStripCtlLibU::HitTestConstants 
HitTestConstants
 Flags used with the HitTest method
typedef enum
TabStripCtlLibU::InsertMarkPositionConstants 
InsertMarkPositionConstants
 Constants that may be used with the SetInsertMarkPosition and GetInsertMarkPosition methods
typedef enum
TabStripCtlLibU::MousePointerConstants 
MousePointerConstants
 Constants used with the MousePointer property
typedef enum
TabStripCtlLibU::OLEActionToContinueWithConstants 
OLEActionToContinueWithConstants
 Constants used with the OLEQueryContinueDrag event
typedef enum
TabStripCtlLibU::OLEDragImageStyleConstants 
OLEDragImageStyleConstants
 Constants used with the OLEDragImageStyle property
typedef enum
TabStripCtlLibU::OLEDropEffectConstants 
OLEDropEffectConstants
 Constants used with OLE drag'n'drop
typedef enum
TabStripCtlLibU::OwnerDrawTabStateConstants 
OwnerDrawTabStateConstants
 Flags used to identify tab states during owner-drawing
typedef enum
TabStripCtlLibU::RegisterForOLEDragDropConstants 
RegisterForOLEDragDropConstants
 Constants used with the RegisterForOLEDragDrop property
typedef enum
TabStripCtlLibU::RightToLeftConstants 
RightToLeftConstants
 Flags used with the RightToLeft property
typedef enum
TabStripCtlLibU::StyleConstants 
StyleConstants
 Constants used with the Style property
typedef enum
TabStripCtlLibU::TabBoundingBoxDefinitionConstants 
TabBoundingBoxDefinitionConstants
 Flags used with the TabBoundingBoxDefinition property
typedef enum
TabStripCtlLibU::TabCaptionAlignmentConstants 
TabCaptionAlignmentConstants
 Constants used with the TabCaptionAlignment property
typedef enum
TabStripCtlLibU::TabIdentifierTypeConstants 
TabIdentifierTypeConstants
 Constants used to identify tabs within an ITabStripTabs collection
typedef enum
TabStripCtlLibU::TabPlacementConstants 
TabPlacementConstants
 Constants used with the TabPlacement property
typedef struct
TabStripCtlLibU::RECTANGLE 
RECTANGLE
 Holds the coordinates of a rectangle's opposing corners

Enumerations

enum  AppearanceConstants { a2D, a3D, a3DLight }
 Constants used with the Appearance property More...
enum  BorderStyleConstants { bsNone, bsFixedSingle }
 Constants used with the BorderStyle property More...
enum  DisabledEventsConstants {
  deMouseEvents = 0x01, deClickEvents = 0x02, deKeyboardEvents = 0x08, deTabInsertionEvents = 0x20,
  deTabDeletionEvents = 0x40, deFreeTabData = 0x80, deTabSelectionChanged = 0x40000
}
 Flags used with the DisabledEvents property More...
enum  DropDescriptionIconConstants {
  ddiNone = -1, ddiNoDrop = 0, ddiCopy = 1, ddiMove = 2,
  ddiLink = 4, ddiMetadataChange = 6, ddiWarning = 7, ddiUseDefault = 8
}
 Constants used with the IOLEDataObject::GetDropDescription and IOLEDataObject::SetDropDescription methods More...
enum  FilteredPropertyConstants {
  fpIconIndex = 4, fpIndex = 6, fpTabData = 7, fpSelected = 9,
  fpText = 11
}
 Constants used with the ITabStripTabs::Filter property More...
enum  FilterTypeConstants { ftDeactivated, ftIncluding, ftExcluding }
 Constants used with the ITabStripTabs::FilterType property More...
enum  HitTestConstants {
  htNotOverTab = 0x0001, htTabIcon = 0x0002, htTabLabel = 0x0004, htTab = 0x0006,
  htAbove = 0x0100, htBelow = 0x0200, htToRight = 0x0400, htToLeft = 0x0800,
  htClientArea = 0x1000, htCloseButton = 0x2000
}
 Flags used with the HitTest method More...
enum  InsertMarkPositionConstants { impNowhere = 0, impBefore = 1, impAfter = 2, impDontChange = 3 }
 Constants that may be used with the SetInsertMarkPosition and GetInsertMarkPosition methods More...
enum  MousePointerConstants {
  mpDefault, mpArrow, mpCross, mpIBeam,
  mpIcon, mpSize, mpSizeNESW, mpSizeNS,
  mpSizeNWSE, mpSizeEW, mpUpArrow, mpHourglass,
  mpNoDrop, mpArrowHourglass, mpArrowQuestion, mpSizeAll,
  mpHand, mpInsertMedia, mpScrollAll, mpScrollN,
  mpScrollNE, mpScrollE, mpScrollSE, mpScrollS,
  mpScrollSW, mpScrollW, mpScrollNW, mpScrollNS,
  mpScrollEW, mpCustom = 0x63
}
 Constants used with the MousePointer property More...
enum  OLEActionToContinueWithConstants { oatcwContinue = 0x0, oatcwCancel = 0x40101, oatcwDrop = 0x40100 }
 Constants used with the OLEQueryContinueDrag event More...
enum  OLEDragImageStyleConstants { odistClassic, odistAeroIfAvailable }
 Constants used with the OLEDragImageStyle property More...
enum  OLEDropEffectConstants {
  odeNone = 0, odeCopy = 1, odeMove = 2, odeLink = 4,
  odeCopyOrMove = odeCopy | odeMove, odeScroll = 0x80000000
}
 Constants used with OLE drag'n'drop More...
enum  OwnerDrawTabStateConstants { odtsSelected = 0x1 }
 Flags used to identify tab states during owner-drawing More...
enum  RegisterForOLEDragDropConstants { rfoddNoDragDrop, rfoddNativeDragDrop, rfoddAdvancedDragDrop }
 Constants used with the RegisterForOLEDragDrop property More...
enum  RightToLeftConstants { rtlText = 1, rtlLayout = 2 }
 Flags used with the RightToLeft property More...
enum  StyleConstants { sTabs, sButtons, sFlatButtons }
 Constants used with the Style property More...
enum  TabBoundingBoxDefinitionConstants { tbbdTabIcon = htTabIcon, tbbdTabLabel = htTabLabel, tbbdTabCloseButton = htCloseButton }
 Flags used with the TabBoundingBoxDefinition property More...
enum  TabCaptionAlignmentConstants { tcaNormal, tcaForceIconLeft, tcaForceCaptionLeft }
 Constants used with the TabCaptionAlignment property More...
enum  TabIdentifierTypeConstants { titID, titIndex }
 Constants used to identify tabs within an ITabStripTabs collection More...
enum  TabPlacementConstants { tpTop, tpBottom, tpLeft, tpRight }
 Constants used with the TabPlacement property More...

Detailed Description

Contains COM definitions for the control's public interface

This is the Unicode version of the TabStrip COM library.

Typedef Documentation

Constants used with the Appearance property

See Also
ITabStrip::Appearance

Constants used with the BorderStyle property

See Also
ITabStrip::BorderStyle

Flags used with the DisabledEvents property

See Also
ITabStrip::DisabledEvents

Flags used with the HitTest method

See Also
ITabStrip::HitTest

Constants that may be used with the SetInsertMarkPosition and GetInsertMarkPosition methods

Constants that may be used for the relativePosition parameter of the SetInsertMarkPosition and GetInsertMarkPosition methods.

See Also
ITabStrip::SetInsertMarkPosition, ITabStrip::GetInsertMarkPosition

Constants used with the MousePointer property

See Also
ITabStrip::MousePointer

Constants used with the OLEDragImageStyle property

See Also
ITabStrip::OLEDragImageStyle

Flags used to identify tab states during owner-drawing

See Also
_ITabStripEvents::OwnerDrawTab

Constants used with the RegisterForOLEDragDrop property

See Also
ITabStrip::RegisterForOLEDragDrop

Flags used with the RightToLeft property

See Also
ITabStrip::RightToLeft

Constants used with the Style property

See Also
ITabStrip::Style

Flags used with the TabBoundingBoxDefinition property

See Also
ITabStrip::TabBoundingBoxDefinition

Constants used with the TabCaptionAlignment property

See Also
ITabStrip::TabCaptionAlignment

Constants used to identify tabs within an ITabStripTabs collection

See Also
ITabStripTabs

Constants used with the TabPlacement property

See Also
ITabStrip::TabPlacement

Enumeration Type Documentation

Constants used with the Appearance property

See Also
ITabStrip::Appearance
Enumerator:
a2D 

The control is drawn with a flat border.

a3D 

The control is drawn with a normal 3D border.

a3DLight 

The control is drawn with a light 3D border.

Constants used with the BorderStyle property

See Also
ITabStrip::BorderStyle
Enumerator:
bsNone 

The control is drawn without an inner border.

bsFixedSingle 

The control is drawn with an inner border.

Flags used with the DisabledEvents property

See Also
ITabStrip::DisabledEvents
Enumerator:
deMouseEvents 

Mouse events won't be fired.

The following events won't be fired: MouseDown, MouseUp, MClick, MouseEnter, MouseHover, MouseLeave, TabMouseEnter, TabMouseLeave, MouseMove

Attention
Because the MouseDown and MouseUp events are required to provide the MClick event, it won't be fired anymore, too.
See Also
_ITabStripEvents::MouseDown, _ITabStripEvents::MouseUp, _ITabStripEvents::MClick, _ITabStripEvents::MouseEnter, _ITabStripEvents::MouseHover, _ITabStripEvents::MouseLeave, _ITabStripEvents::TabMouseEnter, _ITabStripEvents::TabMouseLeave, _ITabStripEvents::MouseMove
deClickEvents 

Click events won't be fired.

The following events won't be fired: Click, DblClick, MClick, MDblClick, RClick, RDblClick

See Also
_ITabStripEvents::Click, _ITabStripEvents::DblClick, _ITabStripEvents::MClick, _ITabStripEvents::MDblClick, _ITabStripEvents::RClick, _ITabStripEvents::RDblClick
deKeyboardEvents 

Keyboard events won't be fired.

The following events won't be fired: KeyDown, KeyUp, KeyPress

See Also
_ITabStripEvents::KeyDown, _ITabStripEvents::KeyUp, _ITabStripEvents::KeyPress
deTabInsertionEvents 

Events concerning tab-insertions won't be fired.

The following events won't be fired: InsertingTab, InsertedTab

See Also
_ITabStripEvents::InsertingTab, _ITabStripEvents::InsertedTab
deTabDeletionEvents 

Events concerning tab-deletions won't be fired.

The following events won't be fired: RemovingTab, RemovedTab

See Also
_ITabStripEvents::RemovingTab, _ITabStripEvents::RemovedTab
deFreeTabData 

The FreeTabData event won't be fired.

The following event won't be fired: FreeTabData

See Also
_ITabStripEvents::FreeTabData
deTabSelectionChanged 

The TabSelectionChanged event won't be fired.

The following event won't be fired: TabSelectionChanged

See Also
_ITabStripEvents::TabSelectionChanged

Constants used with the IOLEDataObject::GetDropDescription and IOLEDataObject::SetDropDescription methods

See Also
IOLEDataObject::GetDropDescription, IOLEDataObject::SetDropDescription
Enumerator:
ddiNone 

No drop description is displayed.

ddiNoDrop 

The drop description icon that visualizes the odeNone drop effect is displayed.

ddiCopy 

The drop description icon that visualizes the odeCopy drop effect is displayed.

ddiMove 

The drop description icon that visualizes the odeMove drop effect is displayed.

ddiLink 

The drop description icon that visualizes the odeLink drop effect is displayed.

ddiMetadataChange 

The drop description icon that visualizes a drop, which causes a metadata change, is displayed.

ddiWarning 

The drop description icon that visualizes a warning is displayed.

ddiUseDefault 

The default drop description is displayed.

Remarks
Requires Windows 7 or newer.

Constants used with the ITabStripTabs::Filter property

See Also
ITabStripTabs::Filter
Enumerator:
fpIconIndex 

Retrieve or set the filter that filters by the IconIndex property.

See Also
ITabStripTab::IconIndex
fpIndex 

Retrieve or set the filter that filters by the Index property.

See Also
ITabStripTab::Index
fpTabData 

Retrieve or set the filter that filters by the TabData property.

See Also
ITabStripTab::TabData
fpSelected 

Retrieve or set the filter that filters by the Selected property.

See Also
ITabStripTab::Selected
fpText 

Retrieve or set the filter that filters by the Text property.

See Also
ITabStripTab::Text

Constants used with the ITabStripTabs::FilterType property

See Also
ITabStripTabs::FilterType
Enumerator:
ftDeactivated 

The filter is deactivated.

ftIncluding 

An item must match this filter to be in the collection.

ftExcluding 

An item must not match this filter to be in the collection.

Flags used with the HitTest method

See Also
ITabStrip::HitTest
Enumerator:
htNotOverTab 

Not over a tab.

The specified point lies not on a tab.

htTabIcon 

On a tab's icon.

The specified point lies on a tab's icon.

htTabLabel 

On a tab's label.

The specified point lies on a tab's text label.

htTab 

On a tab.

The specified point lies on a tab's icon or text label.

htAbove 

Above the control's window rectangle.

The specified point lies above the control's window rectangle.

htBelow 

Below the control's window rectangle.

The specified point lies below the control's window rectangle.

htToRight 

To the right of the control's window rectangle.

The specified point lies to the right of the control's window rectangle.

htToLeft 

To the left of the control's window rectangle.

The specified point lies to the left of the control's window rectangle.

htClientArea 

In the control's client area.

The specified point lies in the control's client area.

htCloseButton 

In a close button's bounding rectangle.

The specified point lies in the bounding rectangle of one of the control's close buttons.

Constants that may be used with the SetInsertMarkPosition and GetInsertMarkPosition methods

Constants that may be used for the relativePosition parameter of the SetInsertMarkPosition and GetInsertMarkPosition methods.

See Also
ITabStrip::SetInsertMarkPosition, ITabStrip::GetInsertMarkPosition
Enumerator:
impNowhere 

The insertion mark is or will be removed.

impBefore 

The insertion mark is or will be placed before the tab.

impAfter 

The insertion mark is or will be placed after the tab.

impDontChange 

The insertion mark won't be (re-)moved.

Constants used with the MousePointer property

See Also
ITabStrip::MousePointer
Enumerator:
mpDefault 

The default mouse cursor is used.

mpArrow 

The default arrow is used as mouse cursor.

mpCross 

A cross is used as mouse cursor.

mpIBeam 

A vertical beam (like in textboxes) is used as mouse cursor.

mpIcon 

An icon is used as mouse cursor.

mpSize 

A mouse cursor indicating window sizing is used.

mpSizeNESW 

A mouse cursor indicating window sizing is used.

This is the cursor that is used while resizing a window into the direction of its upper-right or lower-left corner.

mpSizeNS 

A mouse cursor indicating window sizing is used.

This is the cursor that is used while resizing a window into the direction of its upper or lower border.

mpSizeNWSE 

A mouse cursor indicating window sizing is used.

This is the cursor that is used while resizing a window into the direction of its upper-left or lower-right corner.

mpSizeEW 

A mouse cursor indicating window sizing is used.

This is the cursor that is used while resizing a window into the direction of its left or right border.

mpUpArrow 

An arrow pointing upwardly is used as mouse cursor.

mpHourglass 

An hourglass is used as mouse cursor.

mpNoDrop 

An mouse cursor indicating that the control can't be a drop target is used.

mpArrowHourglass 

The default arrow with a small hourglass is used as mouse cursor.

mpArrowQuestion 

The default arrow with a small question mark is used as mouse cursor.

mpSizeAll 

A mouse cursor indicating window sizing to all directions is used.

mpHand 

A hand typically used for hyperlinks is used as mouse cursor.

mpInsertMedia 

A mouse cursor indicating that the program waits for some media is used.

mpScrollAll 

A mouse cursor indicating scrolling to all directions is used.

mpScrollN 

A mouse cursor indicating scrolling upwardly is used.

mpScrollNE 

A mouse cursor indicating scrolling to the window's upper-right corner is used.

mpScrollE 

A mouse cursor indicating scrolling to the window's right border is used.

mpScrollSE 

A mouse cursor indicating scrolling to the window's lower-right corner is used.

mpScrollS 

A mouse cursor indicating scrolling downwards is used.

mpScrollSW 

A mouse cursor indicating scrolling to the window's lower-left corner is used.

mpScrollW 

A mouse cursor indicating scrolling to the window's left border is used.

mpScrollNW 

A mouse cursor indicating scrolling to the window's upper-left corner is used.

mpScrollNS 

A mouse cursor indicating scrolling upwardly or downwards is used.

mpScrollEW 

A mouse cursor indicating scrolling to the window's left or right border is used.

mpCustom 

The custom mouse cursor defined by the MouseIcon property is used.

Constants used with the OLEQueryContinueDrag event

See Also
_ITabStripEvents::OLEQueryContinueDrag, _ITabStripEvents::OLEGiveFeedback, ITabStrip::OLEDrag
Enumerator:
oatcwContinue 

Continue the drag'n'drop operation.

oatcwCancel 

Cancel the drag'n'drop operation.

oatcwDrop 

Complete the drag'n'drop operation.

Constants used with the OLEDragImageStyle property

See Also
ITabStrip::OLEDragImageStyle
Enumerator:
odistClassic 

OLE drag images will be generated in classic style.

odistAeroIfAvailable 

OLE drag images will be generated in Aero (Vista) style on systems supporting it and in classic style on other systems.

Remarks
Aero style is supported by Windows Vista and newer systems.
The icons for Aero style drag images are taken from the hHighResImageList image list.
See Also
ITabStrip::hHighResImageList

Constants used with OLE drag'n'drop

See Also
_ITabStripEvents::OLEDragEnter, _ITabStripEvents::OLEDragMouseMove, _ITabStripEvents::OLEDragDrop
Enumerator:
odeNone 

No OLE drag and drop operation has occurred or will occur.

odeCopy 

A copy has occured or will occur.

odeMove 

A move has occured or will occur.

odeLink 

A link has occured or will occur.

odeCopyOrMove 

Combination of odeCopy and odeMove.

odeScroll 

The drop target window has scrolled or will scroll.

Flags used to identify tab states during owner-drawing

See Also
_ITabStripEvents::OwnerDrawTab
Enumerator:
odtsSelected 

The tab is selected.

Constants used with the RegisterForOLEDragDrop property

See Also
ITabStrip::RegisterForOLEDragDrop
Enumerator:
rfoddNoDragDrop 

OLE drag'n'drop support is deactivated.

rfoddNativeDragDrop 

The built-in OLE drag'n'drop support of SysTabControl32 is used.

The built-in OLE drag'n'drop support of SysTabControl32 is used. The control automatically highlights the tab below the mouse cursor.

rfoddAdvancedDragDrop 

OLE drag'n'drop is done by the TabStrip class.

OLE drag'n'drop is done by the TabStrip class, giving the client application full control over OLE drag'n'drop.

Flags used with the RightToLeft property

See Also
ITabStrip::RightToLeft
Enumerator:
rtlText 

Read text from right to left.

The tabs' text is read from right to left, but the general layout is left to right, e. g. the arrow buttons for tab scrolling are displayed on the control's right side.

rtlLayout 

Use a right to left layout.

The general layout is right to left, e. g. the arrow buttons for tab scrolling are displayed on the control's left side.

Constants used with the Style property

See Also
ITabStrip::Style
Enumerator:
sTabs 

The tabs appear as tabs.

sButtons 

The tabs appear as buttons and no border is drawn around the client area.

sFlatButtons 

The tabs appear as flat buttons and no border is drawn around the client area.

See Also
ITabStrip::ShowButtonSeparators, ITabStrip::FocusOnButtonDown

Flags used with the TabBoundingBoxDefinition property

See Also
ITabStrip::TabBoundingBoxDefinition
Enumerator:
tbbdTabIcon 

A tab's icon is handled as part of the tab.

tbbdTabLabel 

A tab's text label is handled as part of the tab.

tbbdTabCloseButton 

A tab's close button is handled as part of the tab.

Constants used with the TabCaptionAlignment property

See Also
ITabStrip::TabCaptionAlignment
Enumerator:
tcaNormal 

The tab's icon and text are centered.

tcaForceIconLeft 

The tab's icon is left-aligned.

tcaForceCaptionLeft 

The tab's icon and text are left-aligned.

Constants used to identify tabs within an ITabStripTabs collection

See Also
ITabStripTabs
Enumerator:
titID 

The tab is identified by an unique ID.

A tab's ID will never change.

See Also
ITabStripTab::ID
titIndex 

The tab is identified by a zero-based index.

Reordering the tabs won't change a tab's index, but removing or adding new tabs may do so.

Remarks
This is the preferred and fastest method to identify a tab.
See Also
ITabStripTab::Index

Constants used with the TabPlacement property

See Also
ITabStrip::TabPlacement
Enumerator:
tpTop 

The tabs appear at the top of the control.

tpBottom 

The tabs appear at the bottom of the control.

Remarks
This value doesn't work well for themed tabstrips.
tpLeft 

The tabs appear at the left side of the control.

Remarks
This value doesn't work well for themed tabstrips.
tpRight 

The tabs appear at the right side of the control.

Remarks
This value doesn't work well for themed tabstrips.