kutils Library API Documentation

KMultiTabBar Class Reference

A Widget for horizontal and vertical tabs. More...

#include <kmultitabbar.h>

Inheritance diagram for KMultiTabBar:

QWidget List of all members.

Public Types

enum  KMultiTabBarMode { Horizontal, Vertical }
enum  KMultiTabBarPosition { Left, Right, Top, Bottom }
enum  KMultiTabBarStyle { VSNET = 0, KDEV3 = 1, KONQSBC = 2, STYLELAST = 0xffff }

Public Member Functions

 KMultiTabBar (KMultiTabBarMode bm, QWidget *parent=0, const char *name=0)
int appendButton (const QPixmap &pic, int id=-1, QPopupMenu *popup=0, const QString &not_used_yet=QString::null)
void removeButton (int id)
int appendTab (const QPixmap &pic, int id=-1, const QString &text=QString::null)
void removeTab (int id)
void setTab (int id,bool state)
bool isTabRaised (int id) const
KMultiTabBarButtonbutton (int id) const
KMultiTabBarTabtab (int id) const
void setPosition (KMultiTabBarPosition pos)
void setStyle (KMultiTabBarStyle style)
QPtrList< KMultiTabBarTab > * tabs ()
QPtrList< KMultiTabBarButton > * buttons ()
void showActiveTabTexts (bool show=true)

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 52 of file kmultitabbar.h.


Member Enumeration Documentation

enum KMultiTabBar::KMultiTabBarStyle
 

VSNET == Visual Studio .Net like (only show the text of active tabs KDEV3 == Kdevelop 3 like (always show the text) KONQSBC == konqy's classic sidebar style (unthemed), this one is disabled at the moment, but will be renabled soon too.

Definition at line 65 of file kmultitabbar.h.


Member Function Documentation

int KMultiTabBar::appendButton const QPixmap pic,
int  id = -1,
QPopupMenu popup = 0,
const QString not_used_yet = QString::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 672 of file kmultitabbar.cpp.

References QPtrList< KMultiTabBarButton >::append(), and QBoxLayout::insertWidget().

void KMultiTabBar::removeButton int  id  ) 
 

remove a button with the given ID

Definition at line 704 of file kmultitabbar.cpp.

References QPtrList< KMultiTabBarButton >::at(), QPtrList< KMultiTabBarButton >::count(), and QPtrList< KMultiTabBarButton >::take().

int KMultiTabBar::appendTab const QPixmap pic,
int  id = -1,
const QString text = QString::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

Definition at line 683 of file kmultitabbar.cpp.

void KMultiTabBar::removeTab int  id  ) 
 

remove a tab with a given ID

Definition at line 717 of file kmultitabbar.cpp.

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 722 of file kmultitabbar.cpp.

References KMultiTabBarTab::setState(), and tab().

bool KMultiTabBar::isTabRaised int  id  )  const
 

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

Definition at line 731 of file kmultitabbar.cpp.

References QPushButton::isOn(), and tab().

KMultiTabBarButton * KMultiTabBar::button int  id  )  const
 

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

Definition at line 689 of file kmultitabbar.cpp.

References QPtrListIterator::current().

KMultiTabBarTab * KMultiTabBar::tab int  id  )  const
 

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

Definition at line 697 of file kmultitabbar.cpp.

Referenced by isTabRaised(), and setTab().

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 753 of file kmultitabbar.cpp.

References QPtrList< KMultiTabBarButton >::at(), and QPtrList< KMultiTabBarButton >::count().

void KMultiTabBar::setStyle KMultiTabBarStyle  style  ) 
 

set the display style of the tabs

Definition at line 748 of file kmultitabbar.cpp.

QPtrList< KMultiTabBarTab > * KMultiTabBar::tabs  ) 
 

be carefull, don't delete tabs yourself and don't delete the list itself

Definition at line 761 of file kmultitabbar.cpp.

QPtrList< KMultiTabBarButton > * KMultiTabBar::buttons  ) 
 

be carefull, don't delete buttons yourself and don't delete the list itself

Definition at line 762 of file kmultitabbar.cpp.

void KMultiTabBar::showActiveTabTexts bool  show = true  ) 
 

might vanish, not sure yet

Definition at line 743 of file kmultitabbar.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kutils Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Apr 21 18:44:18 2004 by doxygen 1.3.6-20040222 written by Dimitri van Heesch, © 1997-2003