#include <tdemultitabbar.h>

Inherits TQWidget.

Public Types
enum	KMultiTabBarMode { Horizontal , Vertical }

enum	KMultiTabBarPosition { Left , Right , Top , Bottom }

enum	KMultiTabBarStyle { VSNET =0 , KDEV3 =1 , KONQSBC =2 , KDEV3ICON =3 , STYLELAST =0xffff }

Public Member Functions
	KMultiTabBar (KMultiTabBarMode bm, TQWidget parent=0, const char name=0)

virtual	~KMultiTabBar ()

int	appendButton (const TQPixmap &pic, int id=-1, TQPopupMenu *popup=0, const TQString &not_used_yet=TQString::null)

void	removeButton (int id)

int	appendTab (const TQPixmap &pic, int id=-1, const TQString &text=TQString::null)

void	removeTab (int id)

void	setTab (int id, bool state)

bool	isTabRaised (int id) const

class KMultiTabBarButton *	button (int id) const

class KMultiTabBarTab *	tab (int id) const

void	setPosition (KMultiTabBarPosition pos)

KMultiTabBarPosition	position () const

void	setStyle (KMultiTabBarStyle style)

KMultiTabBarStyle	tabStyle () const

TQPtrList< KMultiTabBarTab > *	tabs ()

TQPtrList< KMultiTabBarButton > *	buttons ()

void	showActiveTabTexts (bool show=true)

Protected Member Functions
virtual void	fontChange (const TQFont &)

void	updateSeparator ()

Friends
class	KMultiTabBarButton

Detailed Description

A Widget for horizontal and vertical tabs.

It is possible to add normal buttons to the top/left The handling if only one tab at a time or multiple tabs should be raisable is left to the "user".

Author: Joseph Wenninger

Definition at line 56 of file tdemultitabbar.h.

Member Enumeration Documentation

◆ KMultiTabBarMode

enum KMultiTabBar::KMultiTabBarMode

The tab bar's orientation.

Also constraints the bar's position.

Enumerator
Horizontal	Horizontal orientation (i.e. on top or bottom)
Vertical	Vertical orientation (i.e. on the left or right hand side)

Definition at line 63 of file tdemultitabbar.h.

◆ KMultiTabBarPosition

enum KMultiTabBar::KMultiTabBarPosition

The tab bar's position.

Enumerator
Left	Left hand side.
Right	Right hand side.
Top	On top.
Bottom	On bottom.

Definition at line 71 of file tdemultitabbar.h.

◆ KMultiTabBarStyle

enum KMultiTabBar::KMultiTabBarStyle

The list of available styles for KMultiTabBar.

Enumerator
VSNET	Visual Studio .Net like (only show the text of active tabs)
KDEV3	KDevelop 3 like (always show the text)
KONQSBC	Konqueror's classic sidebar style (unthemed) (currently disabled)
KDEV3ICON	KDevelop 3 like with icons.
STYLELAST	Last style.

Definition at line 81 of file tdemultitabbar.h.

Constructor & Destructor Documentation

◆ KMultiTabBar()

KMultiTabBar::KMultiTabBar	(	KMultiTabBarMode	bm,
		TQWidget *	parent = `0`,
		const char *	name = `0`
	)

Constructor.

Parameters

bm	The tab bar's orientation
parent	The parent widget
name	The widget's name

Definition at line 835 of file tdemultitabbar.cpp.

◆ ~KMultiTabBar()

KMultiTabBar::~KMultiTabBar ( )

virtual

Destructor.

Definition at line 868 of file tdemultitabbar.cpp.

Member Function Documentation

◆ appendButton()

int KMultiTabBar::appendButton	(	const TQPixmap &	pic,
		int	id = `-1`,
		TQPopupMenu *	popup = `0`,
		const TQString &	not_used_yet = `TQString::null`
	)

append a new button to the button area.

The button can later on be accessed with button(ID) eg for connecting signals to it

Parameters

pic	a pixmap for the button
id	an arbitraty ID value. It will be emitted in the clicked signal for identifying the button if more than one button is connected to a signals.
popup	A popup menu which should be displayed if the button is clicked
not_used_yet	will be used for a popup text in the future

Definition at line 877 of file tdemultitabbar.cpp.

◆ appendTab()

int KMultiTabBar::appendTab	(	const TQPixmap &	pic,
		int	id = `-1`,
		const TQString &	text = `TQString::null`
	)

append a new tab to the tab area.

It can be accessed lateron with tabb(id);

Parameters

pic	a bitmap for the tab
id	an arbitrary ID which can be used later on to identify the tab
text	if a mode with text is used it will be the tab text, otherwise a mouse over hint

Returns: Always zero. Can be safely ignored.

Definition at line 901 of file tdemultitabbar.cpp.

◆ button()

KMultiTabBarButton * KMultiTabBar::button ( int id ) const

get a pointer to a button within the button area identified by its ID

Parameters

id	The id of the tab

Definition at line 907 of file tdemultitabbar.cpp.

◆ buttons()

TQPtrList< KMultiTabBarButton > * KMultiTabBar::buttons ( )

Returns the list of pointers to the tab buttons of type KMultiTabBarButton.

Returns: The list of tab buttons.

Warning: be careful, don't delete buttons yourself and don't delete the list itself

Definition at line 996 of file tdemultitabbar.cpp.

◆ fontChange()

void KMultiTabBar::fontChange ( const TQFont & )

protectedvirtual

Definition at line 988 of file tdemultitabbar.cpp.

◆ isTabRaised()

bool KMultiTabBar::isTabRaised ( int id ) const

return the state of a tab, identified by it's ID

Parameters

id	The ID of the tab to raise

Definition at line 949 of file tdemultitabbar.cpp.

◆ position()

KMultiTabBar::KMultiTabBarPosition KMultiTabBar::position ( ) const

get the tabbar position.

Returns: The tab bar's position

Definition at line 984 of file tdemultitabbar.cpp.

◆ removeButton()

void KMultiTabBar::removeButton ( int id )

remove a button with the given ID

Definition at line 922 of file tdemultitabbar.cpp.

◆ removeTab()

void KMultiTabBar::removeTab ( int id )

remove a tab with a given ID

Parameters

id	The ID of the tab to remove

Definition at line 935 of file tdemultitabbar.cpp.

◆ setPosition()

void KMultiTabBar::setPosition ( KMultiTabBarPosition pos )

set the real position of the widget.

Parameters

pos	if the mode is horizontal, only use top, bottom, if it is vertical use left or right

Definition at line 976 of file tdemultitabbar.cpp.

◆ setStyle()

void KMultiTabBar::setStyle ( KMultiTabBarStyle style )

set the display style of the tabs

Parameters

style The new display style

Definition at line 966 of file tdemultitabbar.cpp.

◆ setTab()

void KMultiTabBar::setTab	(	int	id,
		bool	state
	)

set a tab to "raised"

Parameters

id	The ID of the tab to manipulate
state	true == activated/raised, false == not active

Definition at line 940 of file tdemultitabbar.cpp.

◆ showActiveTabTexts()

void KMultiTabBar::showActiveTabTexts ( bool show = true )

might vanish, not sure yet

Definition at line 961 of file tdemultitabbar.cpp.

◆ tab()

KMultiTabBarTab * KMultiTabBar::tab ( int id ) const

get a pointer to a tab within the tab area, identified by its ID

Definition at line 915 of file tdemultitabbar.cpp.

◆ tabs()

TQPtrList< KMultiTabBarTab > * KMultiTabBar::tabs ( )

Returns the list of pointers to the tabs of type KMultiTabBarTab.

Returns: The list of tabs.

Warning: be careful, don't delete tabs yourself and don't delete the list itself

Definition at line 995 of file tdemultitabbar.cpp.

◆ tabStyle()

KMultiTabBar::KMultiTabBarStyle KMultiTabBar::tabStyle ( ) const

get the display style of the tabs

Returns: display style

Definition at line 971 of file tdemultitabbar.cpp.

◆ updateSeparator()

void KMultiTabBar::updateSeparator ( )

protected

Definition at line 888 of file tdemultitabbar.cpp.

Friends And Related Function Documentation

◆ KMultiTabBarButton

friend class KMultiTabBarButton

friend

Definition at line 188 of file tdemultitabbar.h.

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

tdeutils

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ KMultiTabBarMode

◆ KMultiTabBarPosition

◆ KMultiTabBarStyle

Constructor & Destructor Documentation

◆ KMultiTabBar()

◆ ~KMultiTabBar()

Member Function Documentation

◆ appendButton()

◆ appendTab()

◆ button()

◆ buttons()

◆ fontChange()

◆ isTabRaised()

◆ position()

◆ removeButton()

◆ removeTab()

◆ setPosition()

◆ setStyle()

◆ setTab()

◆ showActiveTabTexts()

◆ tab()

◆ tabs()

◆ tabStyle()

◆ updateSeparator()

Friends And Related Function Documentation

◆ KMultiTabBarButton

tdeutils

tdeutils