• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

KWin

KWin::TabBox

KWin::TabBox Class Reference

#include <tabbox.h>

Inheritance diagram for KWin::TabBox:

Inheritance graph
[legend]

List of all members.


Detailed Description

Definition at line 36 of file tabbox.h.


Public Types

enum  SortOrder { StaticOrder, MostRecentlyUsedOrder }

Public Slots

void show ()

Public Member Functions

Client * currentClient ()
ClientList currentClientList ()
int currentDesktop ()
QList< int > currentDesktopList ()
void delayedShow ()
void handleMouseEvent (XEvent *)
void hide ()
bool isDisplayed () const
TabBoxMode mode () const
void nextPrev (bool next=true)
void reconfigure ()
void refDisplay ()
void reset (bool partial_reset=false)
void setCurrentClient (Client *newClient)
void setCurrentDesktop (int newDesktop)
void setMode (TabBoxMode mode)
 TabBox (Workspace *ws)
void unrefDisplay ()
Workspace * workspace () const
 ~TabBox ()

Protected Member Functions

void hideEvent (QHideEvent *)
void paintEvent (QPaintEvent *)
void showEvent (QShowEvent *)

Member Enumeration Documentation

enum KWin::TabBox::SortOrder

Enumerator:
StaticOrder 
MostRecentlyUsedOrder 

Definition at line 51 of file tabbox.h.


Constructor & Destructor Documentation

KWin::TabBox::TabBox ( Workspace *  ws  ) 

Definition at line 57 of file tabbox.cpp.

KWin::TabBox::~TabBox (  ) 

Definition at line 79 of file tabbox.cpp.


Member Function Documentation

Client * KWin::TabBox::currentClient (  ) 

Returns the currently displayed client ( only works in TabBoxWindowsMode ). Returns 0 if no client is displayed.

Definition at line 346 of file tabbox.cpp.

ClientList KWin::TabBox::currentClientList (  ) 

Returns the list of clients potentially displayed ( only works in TabBoxWindowsMode ). Returns an empty list if no clients are available.

Definition at line 360 of file tabbox.cpp.

int KWin::TabBox::currentDesktop (  ) 

Returns the currently displayed virtual desktop ( only works in TabBoxDesktopListMode ) Returns -1 if no desktop is displayed.

Definition at line 373 of file tabbox.cpp.

QList< int > KWin::TabBox::currentDesktopList (  ) 

Returns the list of desktops potentially displayed ( only works in TabBoxDesktopListMode ) Returns an empty list if no desktops are available.

Definition at line 386 of file tabbox.cpp.

void KWin::TabBox::delayedShow (  ) 

Rikkus: please document! (Matthias)

Ok, here's the docs :)

You call delayedShow() instead of show() directly.

If the 'ShowDelay' setting is false, show() is simply called.

Otherwise, we start a timer for the delay given in the settings and only do a show() when it times out.

This means that you can alt-tab between windows and you don't see the tab box immediately. Not only does this make alt-tabbing faster, it gives less 'flicker' to the eyes. You don't need to see the tab box if you're just quickly switching between 2 or 3 windows. It seems to work quite nicely.

Definition at line 680 of file tabbox.cpp.

void KWin::TabBox::handleMouseEvent ( XEvent *  e  ) 

Definition at line 698 of file tabbox.cpp.

void KWin::TabBox::hide (  ) 

Notify effects that the tab box is being hidden.

Definition at line 630 of file tabbox.cpp.

void KWin::TabBox::hideEvent ( QHideEvent *   )  [protected]

hide the icon box if necessary

Definition at line 430 of file tabbox.cpp.

bool KWin::TabBox::isDisplayed (  )  const [inline]

Returns whether the tab box is being displayed, either natively or by an effect.

See also:
refDisplay(), unrefDisplay()

Definition at line 134 of file tabbox.h.

TabBoxMode KWin::TabBox::mode (  )  const [inline]

Returns the current mode, either TabBoxDesktopListMode or TabBoxWindowsMode

See also:
setMode()

Definition at line 113 of file tabbox.h.

void KWin::TabBox::nextPrev ( bool  next = true  ) 

Shows the next or previous item, depending on next

Definition at line 297 of file tabbox.cpp.

void KWin::TabBox::paintEvent ( QPaintEvent *  e  )  [protected]

Paints the tab box

Definition at line 437 of file tabbox.cpp.

void KWin::TabBox::reconfigure (  ) 

Definition at line 656 of file tabbox.cpp.

void KWin::TabBox::refDisplay (  )  [inline]

Increase the reference count, preventing the default tabbox from showing.

See also:
unrefDisplay(), isDisplayed()

Definition at line 123 of file tabbox.h.

void KWin::TabBox::reset ( bool  partial_reset = false  ) 

Resets the tab box to display the active client in TabBoxWindowsMode, or the current desktop in TabBoxDesktopListMode

Definition at line 188 of file tabbox.cpp.

void KWin::TabBox::setCurrentClient ( Client *  newClient  ) 

Change the currently selected client, and notify the effects.

See also:
setCurrentDesktop()

Definition at line 399 of file tabbox.cpp.

void KWin::TabBox::setCurrentDesktop ( int  newDesktop  ) 

Change the currently selected desktop, and notify the effects.

See also:
setCurrentClient()

Definition at line 411 of file tabbox.cpp.

void KWin::TabBox::setMode ( TabBoxMode  mode  ) 

Sets the current mode to mode, either TabBoxDesktopListMode or TabBoxWindowsMode

See also:
mode()

Definition at line 89 of file tabbox.cpp.

void KWin::TabBox::show (  )  [slot]

Notify effects that the tab box is being shown, and only display the default tab box QFrame if no effect has referenced the tab box.

Definition at line 616 of file tabbox.cpp.

void KWin::TabBox::showEvent ( QShowEvent *   )  [protected]

Reimplemented to raise the tab box as well

Definition at line 421 of file tabbox.cpp.

void KWin::TabBox::unrefDisplay (  ) 

Decrease the reference count. Only when the reference count is 0 will the default tab box be shown.

Definition at line 651 of file tabbox.cpp.

Workspace * KWin::TabBox::workspace (  )  const [inline]

Returns the tab box' workspace

Definition at line 103 of file tabbox.h.


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

KWin

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

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libplasma
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal