KDE 4.0 API Reference kopete/kopete
ChatWindowStyle Class Reference
#include <kopetechatwindowstyle.h>
Detailed Description
This class represent a single chat window style.
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, StyleBuildMode styleBuildMode=StyleBuildNormal) | |
| ChatWindowStyle (const QString &styleName, const QString &variantPath, StyleBuildMode styleBuildMode=StyleBuildFast) | |
| ~ChatWindowStyle () | |
| StyleVariants | getVariants () |
| QString | getStyleName () const |
| QString | getStyleBaseHref () const |
| QString | getHeaderHtml () const |
| QString | getFooterHtml () const |
| QString | getIncomingHtml () const |
| QString | getNextIncomingHtml () const |
| QString | getOutgoingHtml () const |
| QString | getNextOutgoingHtml () const |
| QString | getStatusHtml () const |
| QString | getActionIncomingHtml () const |
| QString | getActionOutgoingHtml () const |
| bool | hasActionTemplate () const |
| bool | hasCompact (const QString &variant) const |
| QString | compact (const QString &variant) const |
| void | reload () |
Member Typedef Documentation
StyleVariants is a typedef to a QMap key = Variant Name value = Path to variant CSS file.
Path is relative to Ressources directory.
Definition at line 39 of file kopetechatwindowstyle.h.
Member Enumeration Documentation
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.
Definition at line 46 of file kopetechatwindowstyle.h.
Constructor & Destructor Documentation
| ChatWindowStyle::ChatWindowStyle | ( | const QString & | styleName, | |
| StyleBuildMode | styleBuildMode = StyleBuildNormal | |||
| ) | [explicit] |
| ChatWindowStyle::ChatWindowStyle | ( | const QString & | styleName, | |
| const QString & | variantPath, | |||
| StyleBuildMode | styleBuildMode = StyleBuildFast | |||
| ) |
Definition at line 58 of file kopetechatwindowstyle.cpp.
| ChatWindowStyle::~ChatWindowStyle | ( | ) |
Definition at line 85 of file kopetechatwindowstyle.cpp.
Member Function Documentation
| 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 91 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 101 of file kopetechatwindowstyle.cpp.
| QString ChatWindowStyle::getStyleBaseHref | ( | ) | const |
Get the style ressource directory.
Ressources 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 ressource directory.
Definition at line 106 of file kopetechatwindowstyle.cpp.
| QString ChatWindowStyle::getHeaderHtml | ( | ) | const |
Definition at line 111 of file kopetechatwindowstyle.cpp.
| QString ChatWindowStyle::getFooterHtml | ( | ) | const |
Definition at line 116 of file kopetechatwindowstyle.cpp.
| QString ChatWindowStyle::getIncomingHtml | ( | ) | const |
Definition at line 121 of file kopetechatwindowstyle.cpp.
| QString ChatWindowStyle::getNextIncomingHtml | ( | ) | const |
Definition at line 126 of file kopetechatwindowstyle.cpp.
| QString ChatWindowStyle::getOutgoingHtml | ( | ) | const |
Definition at line 131 of file kopetechatwindowstyle.cpp.
| QString ChatWindowStyle::getNextOutgoingHtml | ( | ) | const |
Definition at line 136 of file kopetechatwindowstyle.cpp.
| QString ChatWindowStyle::getStatusHtml | ( | ) | const |
Definition at line 141 of file kopetechatwindowstyle.cpp.
| QString ChatWindowStyle::getActionIncomingHtml | ( | ) | const |
Definition at line 146 of file kopetechatwindowstyle.cpp.
| QString ChatWindowStyle::getActionOutgoingHtml | ( | ) | const |
Definition at line 151 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 156 of file kopetechatwindowstyle.cpp.
| bool ChatWindowStyle::hasCompact | ( | const QString & | variant | ) | const |
Check if the supplied variant has a compact form.
Definition at line 313 of file kopetechatwindowstyle.cpp.
Return the compact version of the given style variant.
For the unmodified style, this returns "Variants/_compact_.css"
Definition at line 321 of file kopetechatwindowstyle.cpp.
| void ChatWindowStyle::reload | ( | ) |
The documentation for this class was generated from the following files:
