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

kopete/kopete

Public Types | Public Member Functions | List of all members
ChatWindowStyle Class Reference

#include <kopetechatwindowstyle.h>

Inheritance diagram for ChatWindowStyle:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

 ChatWindowStyle (const QString &styleName, StyleBuildMode styleBuildMode=StyleBuildNormal)
 
 ChatWindowStyle (const QString &styleName, const QString &variantPath, StyleBuildMode styleBuildMode=StyleBuildFast)
 
 ~ChatWindowStyle ()
 
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 ()
 
QString getVoiceClipIncomingHtml () const
 
bool hasActionTemplate () const
 
bool hasCompact (const QString &variant) const
 
bool isValid () const
 
void reload ()
 

Detailed Description

This class represent a single chat window style.

Author
Michaƫl Larouche larou.nosp@m.che@.nosp@m.kde.o.nosp@m.rg

Definition at line 30 of file kopetechatwindowstyle.h.

Member Typedef Documentation

typedef QHash<QString,QString> ChatWindowStyle::StyleVariants

StyleVariants is a typedef to a QHash 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 60 of file kopetechatwindowstyle.cpp.

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

Definition at line 66 of file kopetechatwindowstyle.cpp.

ChatWindowStyle::~ChatWindowStyle ( )

Definition at line 93 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 482 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getActionIncomingHtml ( ) const

Definition at line 160 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getActionOutgoingHtml ( ) const

Definition at line 165 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getFileTransferIncomingHtml ( ) const

Definition at line 170 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getFooterHtml ( ) const

Definition at line 130 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getHeaderHtml ( ) const

Definition at line 125 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getIncomingHtml ( ) const

Definition at line 135 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getNextIncomingHtml ( ) const

Definition at line 140 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getNextOutgoingHtml ( ) const

Definition at line 150 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getOutgoingHtml ( ) const

Definition at line 145 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getOutgoingStateErrorHtml ( ) const

Definition at line 190 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getOutgoingStateSendingHtml ( ) const

Definition at line 180 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getOutgoingStateSentHtml ( ) const

Definition at line 185 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getOutgoingStateUnknownHtml ( ) const

Definition at line 195 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getStatusHtml ( ) const

Definition at line 155 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 resource directory.

Definition at line 120 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 115 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 105 of file kopetechatwindowstyle.cpp.

QString ChatWindowStyle::getVoiceClipIncomingHtml ( ) const

Definition at line 175 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 200 of file kopetechatwindowstyle.cpp.

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

Check if the supplied variant has a compact form.

Definition at line 474 of file kopetechatwindowstyle.cpp.

bool ChatWindowStyle::isValid ( ) const

Checks if the style is valid.

Definition at line 99 of file kopetechatwindowstyle.cpp.

void ChatWindowStyle::reload ( )

Reload style from disk.

Definition at line 467 of file kopetechatwindowstyle.cpp.


The documentation for this class was generated from the following files:
  • kopetechatwindowstyle.h
  • kopetechatwindowstyle.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:53:41 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kopete/kopete

Skip menu "kopete/kopete"
  • 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