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

KDECore

KStaticDeleter< type > Class Template Reference

Little helper class to clean up static objects that are held as pointer. More...

#include <kstaticdeleter.h>

Inheritance diagram for KStaticDeleter< type >:

Inheritance graph
[legend]

List of all members.


Public Member Functions

virtual void destructObject ()
 KStaticDeleter ()
type * setObject (type *&globalRef, type *obj, bool isArray=false)
KDE_DEPRECATED type * setObject (type *obj, bool isArray=false)
virtual ~KStaticDeleter ()

Detailed Description

template<class type>
class KStaticDeleter< type >

Little helper class to clean up static objects that are held as pointer.

When the library is unloaded, or the app terminated, all static deleters are destroyed, which in turn destroys those static objects properly. There are some rules which you should accept in the KStaticDeleter managed class:

  • Don't rely on the global reference variable in the destructor of the object, it will be '0' at destruction time.
  • Don't rely on other KStaticDeleter managed objects in the destructor of the object, because it may be destroyed before your destructor get called. This one can be tricky, because you might not know that you actually use a KStaticDeleter managed class. So try to keep your destructor simple.
A typical use is
 static KStaticDeleter<MyClass> sd;

 MyClass &MyClass::self() {
   if (!_self) { sd.setObject(_self, new MyClass()); }
   return *_self;
 }

Definition at line 74 of file kstaticdeleter.h.


Constructor & Destructor Documentation

template<class type>
KStaticDeleter< type >::KStaticDeleter (  )  [inline]

Definition at line 76 of file kstaticdeleter.h.

template<class type>
virtual KStaticDeleter< type >::~KStaticDeleter (  )  [inline, virtual]

Definition at line 129 of file kstaticdeleter.h.


Member Function Documentation

template<class type>
virtual void KStaticDeleter< type >::destructObject (  )  [inline, virtual]

Destructs the object.

This has the same effect as deleting the KStaticDeleter.

Reimplemented from KStaticDeleterBase.

Definition at line 120 of file kstaticdeleter.h.

template<class type>
type* KStaticDeleter< type >::setObject ( type *&  globalRef,
type *  obj,
bool  isArray = false 
) [inline]

Sets the object to delete and registers the object to be deleted to KGlobal.

If the given object is 0, the former registration is unregistered.

Parameters:
globalRef the static pointer where this object is stored This pointer will be reset to 0 after deletion of the object.
obj the object to delete
isArray tells the destructor to delete an array instead of an object

Definition at line 104 of file kstaticdeleter.h.

template<class type>
KDE_DEPRECATED type* KStaticDeleter< type >::setObject ( type *  obj,
bool  isArray = false 
) [inline]

Sets the object to delete and registers the object to be deleted to KGlobal.

If the given object is 0, the former registration is unregistered.

Parameters:
obj the object to delete
isArray tells the destructor to delete an array instead of an object
Deprecated:
See the other setObject variant.

Definition at line 85 of file kstaticdeleter.h.


The documentation for this class was generated from the following file:
  • kstaticdeleter.h

KDECore

Skip menu "KDECore"
  • 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"
  • dcop
  • DNSSD
  • interfaces
  • Kate
  • kconf_update
  • KDECore
  • KDED
  • kdefx
  • KDEsu
  • kdeui
  • KDocTools
  • KHTML
  • KImgIO
  • KInit
  • kio
  • kioslave
  • KJS
  • KNewStuff
  • KParts
  • KUtils
Generated for API Reference by doxygen 1.5.9
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