/usr/include/syndication/rdf/document.h is in kdepimlibs5-dev 4:4.13.0-0ubuntu1.
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 | /*
* This file is part of the syndication library
*
* Copyright (C) 2006 Frank Osterfeld <osterfeld@kde.org>
*
* 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 SYNDICATION_RDF_DOCUMENT_H
#define SYNDICATION_RDF_DOCUMENT_H
#include <syndication/rdf/resourcewrapper.h>
#include <syndication/specificdocument.h>
template <class T> class QList;
namespace Syndication {
namespace RDF {
class Document;
class Model;
class DublinCore;
class Image;
class Item;
class SyndicationInfo;
class TextInput;
//@cond PRIVATE
typedef boost::shared_ptr<Document> DocumentPtr;
//@endcond
/**
* Document implementation for RDF, representing an RSS 1.0 feed.
*
* @author Frank Osterfeld
*/
class SYNDICATION_EXPORT Document : public Syndication::SpecificDocument, public ResourceWrapper
{
friend class ::Syndication::RDF::Model;
public:
/**
* creates a wrapper wrapping a null resource
*/
Document();
/**
* creates a document by wrapping a channel resource
*
* @param resource the channel resource to wrap
*/
explicit Document(ResourcePtr resource);
/**
* creates a copy of another document
*
* @param other the document to copy
*/
Document(const Document& other);
/**
* destructor
*/
virtual ~Document();
/**
* compares two documents. Two documents are equal if they wrap
* the same resource. See ResourceWrapper::operator==()
*
* @param other the document to compare to
*/
bool operator==(const Document& other) const;
/**
* assigns another document
*
* @param other the document to assign
*/
Document& operator=(const Document& other);
/**
* Used by visitors for double dispatch. See DocumentVisitor
* for more information.
* @param visitor the visitor calling the method
*/
virtual bool accept(DocumentVisitor* visitor);
/**
* returns whether this document is valid or not.
* Invalid documents do not contain any useful
* information.
*/
bool isValid() const;
/**
* title of the feed (required)
*
* @return feed title as TODO: define format
*/
QString title() const;
/**
* A brief description of the channel's content, function, source, etc.
*
* @return TODO: define format etc.
*/
QString description() const;
/**
* The URL to which an HTML rendering of the channel title will link,
* commonly the parent site's home or news page.
*/
QString link() const;
/**
* returns a dublin core description of the document.
*/
DublinCore dc() const;
/**
* returns syndication information describing how often this feed
* is updated.
*/
SyndicationInfo syn() const;
/**
* list of items contained in this feed
*/
QList<Item> items() const;
/**
* An image to be associated with an HTML rendering of the channel.
*/
Image image() const;
/**
* An optional text input element associated with the channel
*/
TextInput textInput() const;
//@cond PRIVATE
/**
* @internal
* checks the format of titles and returns the results
*
* @param containsMarkup whether the heuristic found HTML markup in
* titles
*/
void getItemTitleFormatInfo(bool* containsMarkup) const;
/**
* @internal
* checks the format of descriptions and returns the results
*
* @param containsMarkup whether the heuristic found HTML markup in
* descriptions
*/
void getItemDescriptionFormatInfo(bool* containsMarkup) const;
//@endcond PRIVATE
/**
* Returns a description of the document for debugging purposes.
*
* @return debug string
*/
virtual QString debugInfo() const;
private:
class Private;
Private* const d;
};
} // namespace RDF
} // namespace Syndication
#endif // SYNDICATION_RDF_DOCUMENT_H
|