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

kopete/kopete

ChatWindowStyle Class Reference

#include <kopetechatwindowstyle.h>

List of all members.

Detailed Description

This class represent a single chat window style.

Author:
Michaël Larouche <larouche@kde.org>

Definition at line 30 of file kopetechatwindowstyle.h.


Public Types

enum  StyleBuildMode { StyleBuildFast, StyleBuildNormal }
typedef QHash< QString, QString > StyleVariants

Public Member Functions

 ChatWindowStyle (const QString &styleName, const QString &variantPath, StyleBuildMode styleBuildMode=StyleBuildFast)
 ChatWindowStyle (const QString &styleName, StyleBuildMode styleBuildMode=StyleBuildNormal)
QString compact (const QString &variant) const
QString getActionIncomingHtml () const
QString getActionOutgoingHtml () const
QString getFileTransferIncomingHtml () const
QString getFooterHtml () const
QString getHeaderHtml () const
QString getIncomingHtml () const
QString getNextIncomingHtml () const
QString getNextOutgoingHtml () const
QString getOutgoingHtml () const
QString getOutgoingStateErrorHtml () const
QString getOutgoingStateSendingHtml () const
QString getOutgoingStateSentHtml () const
QString getOutgoingStateUnknownHtml () const
QString getStatusHtml () const
QString getStyleBaseHref () const
QString getStyleName () const
StyleVariants getVariants ()
bool hasActionTemplate () const
bool hasCompact (const QString &variant) const
void reload ()
 ~ChatWindowStyle ()

Member Typedef Documentation

typedef QHash<QString,QString> ChatWindowStyle::StyleVariants

StyleVariants is a typedef to a QMap key = Variant Name value = Path to variant CSS file.

Path is relative to Resources directory.

Definition at line 39 of file kopetechatwindowstyle.h.

Member Enumeration Documentation

enum ChatWindowStyle::StyleBuildMode

This enum specifies the mode of the constructor

  • StyleBuildFast : Build the style the fatest possible
  • StyleBuildNormal : List all variants of this style.

Require a async dir list.

Enumerator:
StyleBuildFast 
StyleBuildNormal 

Definition at line 46 of file kopetechatwindowstyle.h.

Constructor & Destructor Documentation

ChatWindowStyle::ChatWindowStyle ( const QString &  styleName,
StyleBuildMode  styleBuildMode = StyleBuildNormal 
) [explicit]

Build a single chat window style.

Definition at line 59 of file kopetechatwindowstyle.cpp.

ChatWindowStyle::ChatWindowStyle ( const QString &  styleName,
const QString &  variantPath,
StyleBuildMode  styleBuildMode = StyleBuildFast 
)

Definition at line 65 of file kopetechatwindowstyle.cpp.

ChatWindowStyle::~ChatWindowStyle (  ) 

Definition at line 92 of file kopetechatwindowstyle.cpp.

Member Function Documentation

QString ChatWindowStyle::compact ( const QString &  variant  )  const

Return the compact version of the given style variant.

For the unmodified style, this returns "Variants/_compact_.css"

Definition at line 436 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getActionIncomingHtml (  )  const

Definition at line 153 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getActionOutgoingHtml (  )  const

Definition at line 158 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getFileTransferIncomingHtml (  )  const

Definition at line 163 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getFooterHtml (  )  const

Definition at line 123 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getHeaderHtml (  )  const

Definition at line 118 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getIncomingHtml (  )  const

Definition at line 128 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getNextIncomingHtml (  )  const

Definition at line 133 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getNextOutgoingHtml (  )  const

Definition at line 143 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getOutgoingHtml (  )  const

Definition at line 138 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getOutgoingStateErrorHtml (  )  const

Definition at line 178 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getOutgoingStateSendingHtml (  )  const

Definition at line 168 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getOutgoingStateSentHtml (  )  const

Definition at line 173 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getOutgoingStateUnknownHtml (  )  const

Definition at line 183 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getStatusHtml (  )  const

Definition at line 148 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getStyleBaseHref (  )  const

Get the style resource directory.

Resources directory is the base where all CSS, HTML and images are located.

Adium(and now Kopete too) style directories are disposed like this: StyleName/ Contents/ Resources/

Returns:
the path to the the resource directory.

Definition at line 113 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getStyleName (  )  const

Get the style path.

The style path points to the directory where the style is located. ex: ~/.kde/share/apps/kopete/styles/StyleName/

Returns:
the style path based.

Definition at line 108 of file kopetechatwindowstyle.cpp.

ChatWindowStyle::StyleVariants ChatWindowStyle::getVariants (  ) 

Get the list of all variants for this theme.

If the variant aren't listed, it call the lister before returning the list of the Variants. If the variant are listed, it just return the cached variant list.

Returns:
the StyleVariants QMap.

Definition at line 98 of file kopetechatwindowstyle.cpp.

bool ChatWindowStyle::hasActionTemplate (  )  const

Check if the style has the support for Kopete Action template (Kopete extension).

Returns:
true if the style has Action template.

Definition at line 188 of file kopetechatwindowstyle.cpp.

bool ChatWindowStyle::hasCompact ( const QString &  variant  )  const

Check if the supplied variant has a compact form.

Definition at line 428 of file kopetechatwindowstyle.cpp.

void ChatWindowStyle::reload (  ) 

Reload style from disk.

Definition at line 421 of file kopetechatwindowstyle.cpp.

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

kopete/kopete

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

kdenetwork

Skip menu "kdenetwork"
  • kget
  • kopete
  •   kopete
  •   libkopete
  •       libpapillon
  • krfb
Generated for kdenetwork 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