File: adium-theme-header-info.h

package info (click to toggle)
ktp-text-ui 0.8.1-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 3,680 kB
  • ctags: 1,142
  • sloc: cpp: 9,451; sh: 15; makefile: 9
file content (89 lines) | stat: -rw-r--r-- 4,078 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/***************************************************************************
 *   Copyright (C) 2010 by David Edmundson <kde@davidedmundson.co.uk>      *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
 ***************************************************************************/

#ifndef ADIUMTHEMEHEADERINFO_H
#define ADIUMTHEMEHEADERINFO_H

#include <QtCore/QString>
#include <QtCore/QUrl>
#include <QtCore/QDateTime>

#include "ktpchat_export.h"

/** Containts all the information needed for the header generation from the Adium/Kopete templates */

class AdiumThemeHeaderInfoPrivate;

class KDE_TELEPATHY_CHAT_EXPORT AdiumThemeHeaderInfo
{
public:
    explicit AdiumThemeHeaderInfo();
    explicit AdiumThemeHeaderInfo(const AdiumThemeHeaderInfo &other);
    virtual ~AdiumThemeHeaderInfo();
    AdiumThemeHeaderInfo &operator=(const AdiumThemeHeaderInfo &other);

    /** A name for the chat. For a one-on-one chat, this will be the display name of the
     * remote user. For a group chat, it is the group chat name or topic, as appropriate. */
    QString chatName() const;
    void setChatName(const QString &chatName);

    /** The name of the source account for this chat. (i.e MSN)*/
    QString sourceName() const;
    void setSourceName(const QString &sourceName);

    /** The name of the chat's destination.*/
    QString destinationName() const;
    void setDestinationName(const QString &destinationName);

    /** The serverside (remotely set) name of the chat's destination, such as an MSN display name. */
    QString destinationDisplayName() const;
    void setDestinationDisplayName(const QString &destinationDisplayName);

    //FIXME this documentation should say (optional) - then the handing of not setting it
    //should be handled in the getter method - or even the constructor.
    /** A full path to the image of the remote user. If the remote user does not have an image,
     * or this is a group chat so no image is appropriate, this tag will be replaced by
     * incoming_icon.png, so you should have that file available if this tag is used. */
    QUrl incomingIconPath() const;
    void setIncomingIconPath(const QUrl &incomingIconPath);

    /** A full path to the image for the local user. If the local user does not have an image
     * this tag will be replaced by outgoing_icon.png, so you should have that file available
     * if this tag is used. */
    QUrl outgoingIconPath() const;
    void setOutgoingIconPath(const QUrl &outgoingIconPath);

    /** The time at which the chat was opened. */
    QDateTime timeOpened() const;
    void setTimeOpened(const QDateTime &timeOpened);

    /** The protocol image of the service */
    QString serviceIconImg() const;
    void setServiceIconImage(const QString &serviceIconImg);

    /** The chat is a group chat */
    bool isGroupChat() const;
    void setGroupChat(bool isGroupChat);

private:
    AdiumThemeHeaderInfoPrivate *const d;

};

#endif // ADIUMTHEMEHEADERINFO_H