• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdenetwork API Reference
  • KDE Home
  • Contact Us
 

kopete/libkopete

  • Kopete
  • PropertyTmpl
Public Types | Public Member Functions | Static Public Attributes | List of all members
Kopete::PropertyTmpl Class Reference

#include <kopeteproperty.h>

Public Types

typedef QMap< QString,
PropertyTmpl > 
Map
 
enum  PropertyOption { NoProperty = 0x0, PersistentProperty = 0x1, RichTextProperty = 0x2, PrivateProperty = 0x4 }
 

Public Member Functions

 PropertyTmpl ()
 
 PropertyTmpl (const QString &key, const QString &label, const QString &icon=QString(), PropertyOptions options=NoProperty)
 
 PropertyTmpl (const PropertyTmpl &other)
 
 ~PropertyTmpl ()
 
const QString & icon () const
 
bool isNull () const
 
bool isPrivate () const
 
bool isRichText () const
 
const QString & key () const
 
const QString & label () const
 
bool operator!= (const PropertyTmpl &other) const
 
PropertyTmpl & operator= (const PropertyTmpl &other)
 
bool operator== (const PropertyTmpl &other) const
 
PropertyOptions options () const
 
bool persistent () const
 

Static Public Attributes

static PropertyTmpl null
 

Detailed Description

Author
Stefan Gehn <metz AT gehn.net>
Michaƫl Larouche larou.nosp@m.che@.nosp@m.kde.o.nosp@m.rg

The template class for registering properties in Kopete You need to use this if you want to set properties for a Kopete::Contact

Definition at line 41 of file kopeteproperty.h.

Member Typedef Documentation

typedef QMap<QString, PropertyTmpl> Kopete::PropertyTmpl::Map

A Map of QString and PropertyTmpl objects, based on QMap.

Definition at line 135 of file kopeteproperty.h.

Member Enumeration Documentation

enum Kopete::PropertyTmpl::PropertyOption
Enumerator
NoProperty 
PersistentProperty 
RichTextProperty 
PrivateProperty 

Definition at line 44 of file kopeteproperty.h.

Constructor & Destructor Documentation

Kopete::PropertyTmpl::PropertyTmpl ( )

Constructor only used for empty PropertyTmpl objects.

Note: Only useful for the null object

Definition at line 42 of file kopeteproperty.cpp.

Kopete::PropertyTmpl::PropertyTmpl ( const QString &  key,
const QString &  label,
const QString &  icon = QString(),
PropertyOptions  options = NoProperty 
)

Constructor.

Parameters
keyinternal unique key for this template
labela label to show for properties based on this template
iconname of the icon to show for properties based on this template
optionsset the options for that property. See PropertyOption enum.

Definition at line 50 of file kopeteproperty.cpp.

Kopete::PropertyTmpl::PropertyTmpl ( const PropertyTmpl &  other)

Copy constructor.

Definition at line 74 of file kopeteproperty.cpp.

Kopete::PropertyTmpl::~PropertyTmpl ( )

Destructor.

Definition at line 107 of file kopeteproperty.cpp.

Member Function Documentation

const QString & Kopete::PropertyTmpl::icon ( ) const

Getter for icon to show aside or instead of label()

Definition at line 147 of file kopeteproperty.cpp.

bool Kopete::PropertyTmpl::isNull ( ) const

Returns true if this object is an empty template.

Definition at line 172 of file kopeteproperty.cpp.

bool Kopete::PropertyTmpl::isPrivate ( ) const

Returns true if properties based on this template are invisible to the user.

Definition at line 167 of file kopeteproperty.cpp.

bool Kopete::PropertyTmpl::isRichText ( ) const

Returns true if properties based on this template are HTML formatted.

Definition at line 162 of file kopeteproperty.cpp.

const QString & Kopete::PropertyTmpl::key ( ) const

Getter for the unique key.

Properties based on this template will be stored with this key

Definition at line 137 of file kopeteproperty.cpp.

const QString & Kopete::PropertyTmpl::label ( ) const

Getter for i18ned label.

Definition at line 142 of file kopeteproperty.cpp.

bool Kopete::PropertyTmpl::operator!= ( const PropertyTmpl &  other) const

Definition at line 127 of file kopeteproperty.cpp.

PropertyTmpl & Kopete::PropertyTmpl::operator= ( const PropertyTmpl &  other)

Definition at line 80 of file kopeteproperty.cpp.

bool Kopete::PropertyTmpl::operator== ( const PropertyTmpl &  other) const

Definition at line 118 of file kopeteproperty.cpp.

PropertyTmpl::PropertyOptions Kopete::PropertyTmpl::options ( ) const

Return the options for that property.

Definition at line 152 of file kopeteproperty.cpp.

bool Kopete::PropertyTmpl::persistent ( ) const

Returns true if properties based on this template should be saved across Kopete sessions, false otherwise.

Definition at line 157 of file kopeteproperty.cpp.

Member Data Documentation

PropertyTmpl Kopete::PropertyTmpl::null
static

An empty template, check for it using isNull()

Definition at line 125 of file kopeteproperty.h.


The documentation for this class was generated from the following files:
  • kopeteproperty.h
  • kopeteproperty.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:29:20 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kopete/libkopete

Skip menu "kopete/libkopete"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdenetwork API Reference

Skip menu "kdenetwork API Reference"
  • kget
  • kopete
  •   kopete
  •   libkopete
  • krdc
  • krfb

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal