/usr/include/akonadi/notes/noteutils.h is in kdepimlibs5-dev 4:4.14.10-1ubuntu7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 | /* This file is part of the KDE project
Copyright (C) 2011 Christian Mollekopf <chrigi_1@fastmail.fm>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef NOTEUTILS_H
#define NOTEUTILS_H
#include "akonadi-notes_export.h"
#include <QtCore/QUrl>
class KDateTime;
class QString;
namespace boost {
template <typename T> class shared_ptr;
}
namespace KMime {
class Message;
typedef boost::shared_ptr<Message> MessagePtr;
}
namespace Akonadi {
namespace NoteUtils {
/**
* @return mimetype for notes
* @since 4.8
*/
AKONADI_NOTES_EXPORT QString noteMimeType();
/**
* @return icon for notes
* @since 4.8
*/
AKONADI_NOTES_EXPORT QString noteIconName();
/**
* An attachment for a note
* @since 4.9
*/
class AKONADI_NOTES_EXPORT Attachment
{
public:
/**
* Create an attachment referencing a url only
*/
Attachment( const QUrl &url, const QString &mimetype );
/**
* Create an attachment with the content stored inline
*/
Attachment( const QByteArray &data, const QString &mimetype );
Attachment( const Attachment & );
~Attachment();
bool operator==( const Attachment & ) const;
void operator=( const Attachment & );
/**
* Returns the url for url-only attachments
*/
QUrl url() const;
/**
* Returns the date for inline attachments
*/
QByteArray data() const;
/**
* Returns the mimetype
*/
QString mimetype() const;
/**
* Sets the label to be presented to the user
*/
void setLabel( const QString &label );
/**
* Returns the label of the attachment
*/
QString label() const;
private:
//@cond PRIVATE
class AttachmentPrivate;
AttachmentPrivate * const d_ptr;
Q_DECLARE_PRIVATE( Attachment )
//@endcond
};
/**
* A convenience wrapper around KMime::Message::Ptr for notes
*
* This is the format used by the Akonotes Resource
*
* A note has the following properties:
* uid: globally unique identifier (generated if empty)
* creationDate: timestamp when the note was created (generated if empty)
* lastModified: lastModified (generated if empty)
* classification: one of private, confidential, public. This is only meant as an indication to the user.
* title: title of the note
* text: textual content
* from: author (generated if empty)
* attachments: inline or url only
* custom: key value pair for custom values
*
* Reading a note from an Akonotes akonadi item:
* @code
* if ( item.hasPayload<KMime::Message::Ptr>() ) {
* NoteUtils::NoteMessageWrapper note(item.payload<KMime::Message::Ptr>());
* kDebug() << note.text();
* textIsRich = messageWrapper.textFormat() == Qt::RichText;
* }
* @endcode
*
* Setting the note as payload of an akonadi Item
* @code
* item.setMimeType(NoteUtils::noteMimeType());
* NoteUtils::NoteMessageWrapper note;
* note.setTitle( "title" );
* note.setText( "text" );
* note.setFrom( QString::fromLatin1( "MyApplication@kde4" ) );
* item.setPayload( note.message() );
* @endcode
*
* @author Christian Mollekopf <chrigi_1@fastmail.fm>
* @since 4.8
*/
class AKONADI_NOTES_EXPORT NoteMessageWrapper
{
public:
NoteMessageWrapper();
explicit NoteMessageWrapper( const KMime::MessagePtr & );
~NoteMessageWrapper();
/**
* Set the uid of the note
* @param uid should be globally unique
*/
void setUid( const QString &uid );
/**
* Returns the uid of the note
*/
QString uid() const;
enum Classification {
Public,
Private,
Confidential
};
/**
* Set the classification of the note
*/
void setClassification( Classification );
/**
* Returns the classification of the note
*/
Classification classification() const;
/**
* Set the title of the note
*/
void setTitle( const QString &title );
/**
* Returns the title of the note
*/
QString title() const;
/**
* Set the text of the note
*
* @param format only Qt::PlainText and Qt::RichText is supported
*/
void setText( const QString &text, Qt::TextFormat format = Qt::PlainText );
/**
* Returns the text of the note
*/
QString text() const;
/**
* @return Qt::PlainText or Qt::RichText
*/
Qt::TextFormat textFormat() const;
/**
* @return plaintext version of the text (if richtext)
*/
QString toPlainText() const;
/**
* Set the creation date of the note (stored in the mime header)
*/
void setCreationDate( const KDateTime &creationDate );
/**
* Returns the creation date of the note
*/
KDateTime creationDate() const;
/**
* Set the lastModified-date of the note
*/
void setLastModifiedDate( const KDateTime &lastModifiedDate );
/**
* Returns the lastModified-date of the note
*/
KDateTime lastModifiedDate() const;
/**
* Set the origin (creator) of the note (stored in the mime header)
* This is usually the application creating the note.
* @param from must be an address in the style of foo@kde.org.
*/
void setFrom( const QString &from );
/**
* Returns the origin (creator) of the note
*/
QString from() const;
/**
* Returns a reference to the list of attachments of the note
*/
QList<Attachment> &attachments();
/**
* Returns a reference to the custom-value map
* @return key-value map containing all custom values
*/
QMap<QString, QString> &custom();
/**
* Assemble a KMime message with the given values
*
* The message can then i.e. be stored inside an akonadi item
*/
KMime::MessagePtr message() const;
private:
//@cond PRIVATE
class NoteMessageWrapperPrivate;
NoteMessageWrapperPrivate * const d_ptr;
Q_DECLARE_PRIVATE( NoteMessageWrapper )
//@endcond
};
}
}
#endif
|