• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kutils
 

kutils

Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
KMultiTabBar Class Reference
Main classes | KMultiTabBar related classes

#include <kmultitabbar.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 kmultitabbar.h.

Member Enumeration Documentation

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 kmultitabbar.h.

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 kmultitabbar.h.

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 kmultitabbar.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters
bmThe tab bar's orientation
parentThe parent widget
nameThe widget's name

Definition at line 835 of file kmultitabbar.cpp.

KMultiTabBar::~KMultiTabBar ( )
virtual

Destructor.

Definition at line 868 of file kmultitabbar.cpp.

Member Function Documentation

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
pica pixmap for the button
idan 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.
popupA popup menu which should be displayed if the button is clicked
not_used_yetwill be used for a popup text in the future

Definition at line 877 of file kmultitabbar.cpp.

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
pica bitmap for the tab
idan arbitrary ID which can be used later on to identify the tab
textif 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 kmultitabbar.cpp.

KMultiTabBarButton * KMultiTabBar::button ( int  id) const

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

Parameters
idThe id of the tab

Definition at line 907 of file kmultitabbar.cpp.

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 kmultitabbar.cpp.

bool KMultiTabBar::isTabRaised ( int  id) const

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

Parameters
idThe ID of the tab to raise

Definition at line 949 of file kmultitabbar.cpp.

KMultiTabBar::KMultiTabBarPosition KMultiTabBar::position ( ) const

get the tabbar position.

Returns
The tab bar's position

Definition at line 984 of file kmultitabbar.cpp.

void KMultiTabBar::removeButton ( int  id)

remove a button with the given ID

Definition at line 922 of file kmultitabbar.cpp.

void KMultiTabBar::removeTab ( int  id)

remove a tab with a given ID

Parameters
idThe ID of the tab to remove

Definition at line 935 of file kmultitabbar.cpp.

void KMultiTabBar::setPosition ( KMultiTabBarPosition  pos)

set the real position of the widget.

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

Definition at line 976 of file kmultitabbar.cpp.

void KMultiTabBar::setStyle ( KMultiTabBarStyle  style)

set the display style of the tabs

Parameters
styleThe new display style

Definition at line 966 of file kmultitabbar.cpp.

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

set a tab to "raised"

Parameters
idThe ID of the tab to manipulate
statetrue == activated/raised, false == not active

Definition at line 940 of file kmultitabbar.cpp.

void KMultiTabBar::showActiveTabTexts ( bool  show = true)

might vanish, not sure yet

Definition at line 961 of file kmultitabbar.cpp.

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 kmultitabbar.cpp.

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 kmultitabbar.cpp.

KMultiTabBar::KMultiTabBarStyle KMultiTabBar::tabStyle ( ) const

get the display style of the tabs

Returns
display style

Definition at line 971 of file kmultitabbar.cpp.


The documentation for this class was generated from the following files:
  • kmultitabbar.h
  • kmultitabbar.cpp

kutils

Skip menu "kutils"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

kutils

Skip menu "kutils"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kutils by doxygen 1.8.6
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |