KNewStuff

core/author.h
1 /*
2  This file is part of KNewStuff2.
3  SPDX-FileCopyrightText: 2002 Cornelius Schumacher <[email protected]>
4  SPDX-FileCopyrightText: 2003-2007 Josef Spillner <[email protected]>
5 
6  SPDX-License-Identifier: LGPL-2.1-or-later
7 */
8 
9 #ifndef KNEWSTUFF3_AUTHOR_P_H
10 #define KNEWSTUFF3_AUTHOR_P_H
11 
12 #include <QString>
13 #include <QUrl>
14 
15 #include "knewstuffcore_export.h"
16 
17 namespace KNSCore
18 {
19 struct AuthorPrivate;
20 
21 /**
22  * @short KNewStuff author information.
23  *
24  * This class provides accessor methods to the author data
25  * as used by KNewStuff.
26  * It should probably not be used directly by the application.
27  *
28  * @author Josef Spillner ([email protected])
29  */
30 class KNEWSTUFFCORE_EXPORT Author
31 {
32 public:
33  explicit Author();
34  Author(const Author &other);
35  Author &operator=(const Author &other) = default;
36  Author &operator=(Author &&) = default;
37  ~Author();
38 
39  /**
40  * Sets the user ID of the author.
41  */
42  void setId(const QString &id);
43 
44  /**
45  * Retrieve the author's user ID
46  * @return the author's user ID
47  */
48  QString id() const;
49 
50  /**
51  * Sets the full name of the author.
52  */
53  void setName(const QString &name);
54 
55  /**
56  * Retrieve the author's name.
57  *
58  * @return author name
59  */
60  QString name() const;
61 
62  /**
63  * Sets the email address of the author.
64  */
65  void setEmail(const QString &email);
66 
67  /**
68  * Retrieve the author's email address.
69  *
70  * @return author email address
71  */
72  QString email() const;
73 
74  /**
75  * Sets the jabber address of the author.
76  */
77  void setJabber(const QString &jabber);
78 
79  /**
80  * Retrieve the author's jabber address.
81  *
82  * @return author jabber address
83  */
84  QString jabber() const;
85 
86  /**
87  * Sets the homepage of the author.
88  */
89  void setHomepage(const QString &homepage);
90 
91  /**
92  * Retrieve the author's homepage.
93  *
94  * @return author homepage
95  */
96  QString homepage() const;
97 
98  /**
99  * Sets the profile page of the author, usually located on the server hosting the content.
100  */
101  void setProfilepage(const QString &profilepage);
102 
103  /**
104  * Retrieve the author's profile page.
105  *
106  * @return author profile page
107  */
108  QString profilepage() const;
109 
110  /**
111  * Sets the url for the user's avatar image
112  */
113  void setAvatarUrl(const QUrl &avatarUrl);
114 
115  /**
116  * Retrieve the url of the user's avatar image
117  *
118  * @return a url for the user's avatar (may be empty)
119  */
120  QUrl avatarUrl() const;
121 
122  /**
123  * Retrieve the user's description text
124  *
125  * @return A long(ish)-form text describing this user, usually self-entered
126  */
127  QString description() const;
128  /**
129  * Set the user's description
130  */
131  void setDescription(const QString &description);
132 
133 private:
134  QString mName;
135  QString mEmail;
136  QString mJabber;
137  QString mHomepage;
138 };
139 
140 }
141 
142 #endif
KNSCore
Contains the core functionality for handling interaction with NewStuff providers. ...
Definition: atticaprovider.cpp:27
KNSCore::Author
KNewStuff author information.
Definition: core/author.h:30
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Wed May 12 2021 22:41:39 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.