/usr/include/syndication/rdf/syndicationinfo.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 | /*
* 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_SYNDICATIONINFO_H
#define SYNDICATION_RDF_SYNDICATIONINFO_H
#include <syndication/rdf/resourcewrapper.h>
#include <ctime>
class QString;
namespace Syndication {
namespace RDF {
/**
* Wrapper to access syndication information for a feed.
* The RSS 1.0 syndication module provides syndication hints to
* aggregators regarding how often it is updated.
*
* The specification can be found at
* http://web.resource.org/rss/1.0/modules/syndication/
*
* @author Frank Osterfeld
*/
class SYNDICATION_EXPORT SyndicationInfo : public ResourceWrapper
{
public:
/**
* update period enum as used by updatePeriod().
*/
enum Period
{
Hourly, /**< the feed is updated hourly */
Daily, /**< the feed is updated daily */
Weekly, /**< the feed is updated weekly */
Monthly, /**< the feed is updated monthly */
Yearly /**< the feed is updated yearly */
};
/**
* creates a wrapper wrapping a null resource.
* isNull() will be true.
*/
SyndicationInfo();
/**
* creates a wrapper from a resource
* @param resource the feed resource to read syndication
* information from
*/
explicit SyndicationInfo(ResourcePtr resource);
/**
* virtual destructor
*/
virtual ~SyndicationInfo();
/**
* Describes the period over which the channel format is updated.
* Acceptable values are: hourly, daily, weekly, monthly, yearly.
* If omitted, daily is assumed.
*
* @return update period, daily is default
*/
Period updatePeriod() const;
/** Used to describe the frequency of updates in relation to the
* update period. A positive integer indicates how many times in
* that period the channel is updated. For example, an
* updatePeriod of daily, and an updateFrequency of 2 indicates
* the channel format is updated twice daily. If omitted a value
* of 1 is assumed.
*
* @return update frequency, default is 1
*/
int updateFrequency() const;
/**
* Defines a base date to be used in concert with updatePeriod
* and updateFrequency to calculate the publishing schedule.
*
* @return the base date in seconds since epoch. Default value is
* 0 (epoch).
*/
time_t updateBase() const;
/**
* description of the syndication information
* for debugging purposes
*
* @return debug string
*/
QString debugInfo() const;
protected:
/**
* returns Period value as string.
* @param period period enum to convert to a string
* @return the enum name in lower case, "daily", "hourly", etc.
*/
static QString periodToString(Period period);
/**
* parses a Period value from a string.
*
* @param str a period string as defined in the syndication module
* @return the parsed period, Daily (the default) if the parsed
* string is empty or invalid
*/
static Period stringToPeriod(const QString& str);
};
} // namespace RDF
} // namespace Syndication
#endif // SYNDICATION_RDF_SYNDICATIONINFO_H
|