lib

KoPaletteManager Class Reference

#include <kopalettemanager.h>

List of all members.


Detailed Description

Manages the set of dockwindow palettes and their widgets.

You create one palette manager per view; then you can add widgets to your hearts content. Widgets are grouped into dock windows by palette names. To see the menu entries, add a the following line to your .rc file:

<Action name="view_palette_action_menu">

There are two styles: one that uses tabs and one that uses the vertical QToolBox style to separate and show individual widgets. By implementing the kopalette interface and extending the above enum, you can add more types.

TODO:

  • Drag & Drop
  • Restore order of tabs in a docker
  • Set initial position of floating dockers on first startup
  • Restoration of the application default state
  • Make it impossible to close a floating palette window with alt-f4

Definition at line 85 of file kopalettemanager.h.


Public Slots

void slotTogglePalette (int paletteIndex)
void slotToggleAllPalettes ()
void showAllPalettes (bool shown)
virtual void slotReset ()
virtual void slotResetFont ()

Public Member Functions

 KoPaletteManager (KoView *view, KActionCollection *ac, const char *name)
virtual ~KoPaletteManager ()
virtual void addWidget (QWidget *widget, const QString &name, const QString &paletteName, int position=-1, enumKoPaletteStyle style=PALETTE_DOCKER, bool shown=true)
virtual QWidget * widget (const QString &name)
virtual void showWidget (const QString &name)
virtual void hideWidget (const QString &name)
virtual void removeWidget (const QString &name)
virtual KoPalettecreatePalette (const QString &name, const QString &caption, enumKoPaletteStyle style=PALETTE_DOCKER)
virtual void placePalette (const QString &name, Dock location=DockRight)
virtual void addPalette (KoPalette *palette, const QString &name, Dock location=DockRight)
virtual void setFixedWidth (int w)

Protected Member Functions

bool eventFilter (QObject *o, QEvent *e)

Member Function Documentation

virtual void KoPaletteManager::addPalette KoPalette palette,
const QString &  name,
Dock  location = DockRight
[virtual]
 

Add a palette; this can be used to add palettes other than those in the two default styles.

void KoPaletteManager::addWidget QWidget *  widget,
const QString &  name,
const QString &  paletteName,
int  position = -1,
enumKoPaletteStyle  style = PALETTE_DOCKER,
bool  shown = true
[virtual]
 

Add a new tab with the given name an description to the specified palette.

The widget's caption is used, where necessary. If there is no palette with this name, a new palette is created with the given palette name and the widget's caption.

If there is already a widget with the given name, that widget will be unplugged (but not destroyed) and the given widget will be plugged in place.

If the widget occurs in the saved configuration, it is not added to the specified palette, but in the place where it was left.

Parameters:
widget the widget that will be inserted as a tab or entry in the palette
name the name under which the palette will be stored. Not the caption -- do not i18n this.
paletteName the unique name of the palette this widget will be a child of. If the palette already exists, the current widget is added to it.
position the position of the widget in the palettes
style docker, toolbox or slider

Definition at line 132 of file kopalettemanager.cc.

KoPalette * KoPaletteManager::createPalette const QString &  name,
const QString &  caption,
enumKoPaletteStyle  style = PALETTE_DOCKER
[virtual]
 

Create an empty palette in the given style.

with the given name and caption. If the palette already exists, nothing is done.

Definition at line 328 of file kopalettemanager.cc.

void KoPaletteManager::hideWidget const QString &  name  )  [virtual]
 

hide the specified widget

Definition at line 292 of file kopalettemanager.cc.

virtual void KoPaletteManager::placePalette const QString &  name,
Dock  location = DockRight
[virtual]
 

Move the specified palette to the specified location.

If there is already a location for the palette in the saved settings, then move it there instead of the specified location.

void KoPaletteManager::removeWidget const QString &  name  )  [virtual]
 

Remove the widget with the specified name from whichever palette it is currently in.

If it is the last widget in the palette, the palette is destroyed. If the name does not occur, nothing is done.

Definition at line 307 of file kopalettemanager.cc.

void KoPaletteManager::setFixedWidth int  w  )  [virtual]
 

Sets all palettes to the specified fixed width.

Definition at line 610 of file kopalettemanager.cc.

void KoPaletteManager::showWidget const QString &  name  )  [virtual]
 

Show a the specified palette wherever it currently is.

Definition at line 277 of file kopalettemanager.cc.

void KoPaletteManager::slotReset  )  [virtual, slot]
 

Restores the palette configuration to the default layout, i.e, the layout preferred by each docker.

Definition at line 223 of file kopalettemanager.cc.

void KoPaletteManager::slotResetFont  )  [virtual, slot]
 

Reset the font for all palettes.

Definition at line 263 of file kopalettemanager.cc.

QWidget * KoPaletteManager::widget const QString &  name  )  [virtual]
 

Get a certain widget by name.

Definition at line 272 of file kopalettemanager.cc.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys