OWLNext 6.32
Public Member Functions | Protected Member Functions
owl::TTabControl Class Reference

#include <tabctrl.h>

Inheritance diagram for owl::TTabControl:
owl::TControl owl::TWindow owl::TEventHandler owl::TStreamableBase

List of all members.

Public Member Functions

 TTabControl (TWindow *parent, int id, int x, int y, int w, int h, TModule *module=0)
 TTabControl (TWindow *parent, int resourceId, TModule *module=0)
 TTabControl (HWND hwnd)
 ~TTabControl ()
HWND GetToolTips () const
void SetToolTips (HWND toolTip)
int HitTest (TTabHitTestInfo &)
uint Transfer (void *buffer, TTransferDirection direction)
Add/remove tab items
int Add (const TTabItem &)
int Add (LPCTSTR tabText)
int Insert (const TTabItem &, int index)
int Insert (LPCTSTR tabText, int index)
bool Delete (int index)
bool DeleteAll ()
Set/Querry attributes of TabControl
int GetCount () const
int GetRowCount () const
int GetSel () const
int SetSel (int index)
Set/Querry attributes of Tab Items
bool GetItem (int index, TTabItem &item) const
bool GetItemRect (int index, TRect &rect) const
bool SetItem (int index, const TTabItem &item)
bool SetItemExtra (int extra)
TSize SetItemSize (const TSize &size)
void SetPadding (const TSize &size)
Set/Querry attributes of control window
void AdjustRect (bool clientInWindowOut, TRect &rect)
HIMAGELIST GetImageList () const
HIMAGELIST SetImageList (HIMAGELIST)
void RemoveImage (int index)
New messages
void DeselectAll (bool exclFocus=true)
uint32 GetExtendedStyle () const
uint32 SetExtendedStyle (uint32 mask, uint32 style)
bool HighLightItem (int item, bool highlight=true)
void SetMinTabWidht (int width)

Protected Member Functions

virtual TGetClassNameReturnType GetClassName ()
void EvHScroll (uint scrollCode, uint thumbPos, THandle hWndCtl)
void EvVScroll (uint scrollCode, uint thumbPos, THandle hWndCtl)

Detailed Description

TTabControl encapsulates the tab control - a window that provides a user interface analogous to dividers in a notebook.


Constructor & Destructor Documentation

owl::TTabControl::TTabControl ( TWindow parent,
int  id,
int  x,
int  y,
int  w,
int  h,
TModule module = 0 
)

Constructor for TTabControl. Initializes its data fields using parameters passed and default values by default. A TabControl associated with the TTabControl will:

  • be visible upon creation
  • display only one row of tabs.
owl::TTabControl::TTabControl ( TWindow parent,
int  resourceId,
TModule module = 0 
)

Constructor for a TTabControl object associated with a Tab Control specified in a dialog resource.

owl::TTabControl::TTabControl ( HWND  hwnd)

Constructor for a TTabControl object to be associated with an already created Tab Control.

References owl::TWindow::IsWindow().

owl::TTabControl::~TTabControl ( )

Cleans up if underlying Tab support was provided by ObjectWindows.


Member Function Documentation

int owl::TTabControl::Add ( const TTabItem item)

Inserts a new tab described by the 'item' parameter to the tab control at the position specified by the 'index' parameter. The return value is the index of the new tab or -1 in case of error.

int owl::TTabControl::Add ( LPCTSTR  tabText)

The string pointed to must outlive the control.

void owl::TTabControl::EvHScroll ( uint  scrollCode,
uint  thumbPos,
THandle  hWndCtl 
) [protected]

Keeps TWindow from rerouting this message.It must be left as is for the tab control, as it may originate from the control's spin.

Reimplemented from owl::TWindow.

References owl::TWindow::DefaultProcessing().

void owl::TTabControl::EvVScroll ( uint  scrollCode,
uint  thumbPos,
THandle  hWndCtl 
) [protected]

Keep TWindow from rerouting this message - it must be left as is for the tab control as it may originate from the control's spin.

Reimplemented from owl::TWindow.

References owl::TWindow::DefaultProcessing().

TWindow::TGetClassNameReturnType owl::TTabControl::GetClassName ( ) [protected, virtual]

Returns the class name of the underlying control associated with the TTabControl object.

Reimplemented from owl::TWindow.

int owl::TTabControl::Insert ( LPCTSTR  tabText,
int  index 
)

The string pointed to must outlive the control.

Inserts a new tab with the caption 'tabText' at the specified 'index'. Returns the index of the new tab, if successful.

uint owl::TTabControl::Transfer ( void *  buffer,
TTransferDirection  direction 
) [virtual]

Transfer is not implemented in TTabControl, given that each item interacts with settings outside of the TC_ITEM members. (For example, the image index points to the ImageList).

Reimplemented from owl::TWindow.


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