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

KWinLibraries

KDecorationFactory Class Reference
[KWin decorations library]

#include <kdecorationfactory.h>

Inheritance diagram for KDecorationFactory:

Inheritance graph
[legend]

List of all members.


Detailed Description

Definition at line 37 of file kdecorationfactory.h.


Public Member Functions

void addDecoration (KDecoration *)
virtual QList< BorderSize > borderSizes () const
virtual void checkRequirements (KDecorationProvides *provides)
virtual KDecoration * createDecoration (KDecorationBridge *bridge)=0
bool exists (const KDecoration *deco) const
 KDecorationFactory ()
const KDecorationOptions * options ()
void removeDecoration (KDecoration *)
virtual bool reset (unsigned long changed)
virtual bool supports (Ability ability) const =0
virtual ~KDecorationFactory ()

Protected Member Functions

void resetDecorations (unsigned long changed)
NET::WindowType windowType (unsigned long supported_types, KDecorationBridge *bridge) const

Constructor & Destructor Documentation

KDecorationFactory::KDecorationFactory (  ) 

Constructor.

Called after loading the decoration plugin. All global initialization of the plugin should be done in the factory constructor.

Definition at line 31 of file kdecorationfactory.cpp.

KDecorationFactory::~KDecorationFactory (  )  [virtual]

Destructor.

Called before unloading the decoration plugin. All global cleanup of the plugin should be done in the factory destructor.

Definition at line 35 of file kdecorationfactory.cpp.


Member Function Documentation

void KDecorationFactory::addDecoration ( KDecoration *  deco  ) 

Definition at line 59 of file kdecorationfactory.cpp.

QList< KDecorationDefines::BorderSize > KDecorationFactory::borderSizes (  )  const [virtual]

Reimplement this function if your decoration supports more border sizes than the default one (BorderNormal).

The returned list must contain all supported sizes, ordered from the smallest to the largest one. By default, only BorderNormal is returned.

Definition at line 49 of file kdecorationfactory.cpp.

void KDecorationFactory::checkRequirements ( KDecorationProvides *  provides  )  [virtual]

Definition at line 45 of file kdecorationfactory.cpp.

virtual KDecoration* KDecorationFactory::createDecoration ( KDecorationBridge *  bridge  )  [pure virtual]

This function must be reimplemented to create decoration objects.

The argument should be passed to the KDecoration constructor, the second KDecoration argument should be this factory object.

bool KDecorationFactory::exists ( const KDecoration *  deco  )  const

Returns true if the given decoration object still exists.

This is necessary e.g. when calling KDecoration::showWindowMenu(), which may cause the decoration to be destroyed. Note that this function is reliable only if called immediately after such actions.

Definition at line 54 of file kdecorationfactory.cpp.

void KDecorationFactory::removeDecoration ( KDecoration *  deco  ) 

Definition at line 64 of file kdecorationfactory.cpp.

bool KDecorationFactory::reset ( unsigned long  changed  )  [virtual]

This function is called when the configuration settings changed.

The argument specifies what has changed, using the SettingXXX masks. It should be determined whether the decorations need to be completely remade, in which case true should be returned, or whether only e.g. a repaint will be sufficient, in which case false should be returned, and resetDecorations() can be called to reset all decoration objects. Note that true should be returned only when really necessary.

Definition at line 40 of file kdecorationfactory.cpp.

void KDecorationFactory::resetDecorations ( unsigned long  changed  )  [protected]

Convenience function that calls KDecoration::reset() for all decoration objects.

Definition at line 69 of file kdecorationfactory.cpp.

virtual bool KDecorationFactory::supports ( Ability  ability  )  const [pure virtual]

NET::WindowType KDecorationFactory::windowType ( unsigned long  supported_types,
KDecorationBridge *  bridge 
) const [protected]

This function has the same functionality like KDecoration::windowType().

It can be used in createDecoration() to return different KDecoration inherited classes depending on the window type, as at that time KDecoration::windowType() is not available yet. The additional argument is the one passed to createDecoration().

Definition at line 77 of file kdecorationfactory.cpp.


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

KWinLibraries

Skip menu "KWinLibraries"
  • Main Page
  • Modules
  • 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