class KitSideBar A sidebar with toolbutton functionality. More... Definition #include <sidebar.h> Inherits QFrame (qt) [public ] List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

•  KitSideBar ( QWidget * parent, const char * name = 0 )
•  ~KitSideBar ()
• int  iconSize ()
• int  iconSizeSetting ()
• KitIconTextMenu::IconText  iconText ()
• int  addButton ( int barId, const QString icon, const QString text, const QString tip = QString::null, int id = -1, bool quit = false )
• void  changeButton ( int barId, int id, const QString icon, const QString text, const QString tip = QString::null )
• void  removeButton ( int barId, int id )
• void  setDown ( int barId, int btnId, bool down )
• int  createButtonBar ( const QString text, int id = -1 )
• int  currentBar ()
• QButtonGroup *  getBarPtr ( int barId )
• void  showBar ( int barId )
• void  createClipTray ()
• void  applySettings ( KConfig * config, const QString group = "Sidebar" )
• void  saveSettings ( KConfig * config, const QString group = "Sidebar" )

Public Slots

• void  setButton ( int barId, int btnId )
• void  setIconSize ( int size )
• void  setIconText ( KitIconTextMenu::IconText it )

Signals

• void  barActivated ( int barId )
• void  buttonClicked ( int barId, int btnId )
• void  hidden ()

Protected Methods

• void  mouseReleaseEvent ( QMouseEvent * event )

Protected Slots

• void  showPopup ()
• void  pumHide ()

Detailed Description

KitSideBar is a widget similar to a toolbar in functionality but in a sidebar fashion.

The buttons in this sidebar are tied to the KDE environment. Thus when "default" is selected on the icon size menu the Desktop icon size from the control center is used for the icon size in the application group bar. The bar width is calculated from the fontmetrics of the icon text string and is derived from font settings in the KDE control center..

Constructor

Destructor

Returns: the current icon size - this is the actual icon size

Returns: the current icon size selected - this could be 0 for Default

Returns: the icon text setting

Adds a button to a sidebar.

Parameters:

barId	the id of the bar to add the button to
icon	the name of the icon of the button
text	the button text
tip	the button tooltip
id	the id of the button (if -1 the group button count is used for the id)
quit	the button is a "quit application" button (kapp->quit())

Returns: the id of the button

Change an existing button.

Parameters:

barId	the id of the bar to add the button to
id	the id of the button
icon	the name of the icon of the button
text	the button text
tip	the button tooltip

Remove an existing button.

Parameters:

barId	the id of the bar to add the button to
id	the id of the button

Sets a sidebar button status. This method will not emit button clicked() or pressed() signals.

Parameters:

barId	the id of the bar
btnId	the id of the button
on	sets status of the button

Returns: true if removed

Creates a button sidebar group

Parameters:

text	the button text.
id	the id of the button bar

Returns: the id of the bar created

Returns: the id of the currently visable bar or -1 if no bar exists

Get pointer to a bar.

Parameters:

barId

the id of the bar

Returns: the pointer of the bar button group

Shows a sidebar group.

Parameters:

barId

the id of the bar

Not yet implemented

Applies the saved configuration settings.

Parameters:

group

then configuration file group name

Saves the current settings - does not save the sidebar contents.

Parameters:

group

then configuration file group name

[slot]

Sets a sidebar button down. This method emits button clicked() and pressed() signals.

Parameters:

barId	the id of the bar
btnId	the id of the button

[slot]

Sets the icon size

[slot]

Sets the icon text position

[signal]

Sidebar group activated.

Parameters:

barId

the id of the bar

[signal]

Sidebar button clicked

Parameters:

barId	the id of the bar
btnId	the id of the button

[signal]

Emitted when the sidebar is hidden

[protected]

Used for RMB event to display popup menu

[protected slots slot]

Shows the RMB popup menu.

[protected slots slot]

Hides the entire sidebar.

• Author: Bruce Hunt
• Generated: bhunt on Lurch on Sun Nov 24 02:45:27 2002, using kdoc 2.0a54.