This file is indexed.

/usr/include/kabc/formatfactory.h is in kdepimlibs5-dev 4:4.8.5-0ubuntu0.3.

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
/*
    This file is part of libkabc.
    Copyright (c) 2002 Tobias Koenig <tokoe@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 KABC_FORMATFACTORY_H
#define KABC_FORMATFACTORY_H

#include <QtCore/QHash>
#include <QtCore/QString>

#include <kconfig.h>

#include "format.h"

namespace KABC {

/**
 * Dataype to hold information on format plugins.
 *
 * @see FormatFactory::info()
 */
struct FormatInfo
{
  /**
   * Returns whether this info object is null.
   *
   * An info object is considered null, when its #library string is empty.
   */
  bool isNull() const { return library.isEmpty(); }

  /**
   * Name of a KDE plugin library, e.g.
   * \code
   * "kabcformat_vcard"
   * \endcode
   *
   * Maps to the @c X-KDE-Library field of the format plugin's .desktop file
   */
  QString library;

  /**
   * Localized string used as format's name, e.g.
   * \code
   * i18n( "vCard" )
   * \endcode
   *
   * Maps to the @c Name field of the format plugin's .desktop file
   */
  QString nameLabel;

  /**
   * Localized string to describe the format, e.g.
   * \code
   * i18n( "vCard format" )
   * \endcode
   *
   * Maps to the @c Comment field of the format plugin's .desktop file
   */
  QString descriptionLabel;
};

/**
 * Class for loading format plugins.
 *
 * Example:
 *
 * \code
 * KABC::FormatFactory *factory = KABC::FormatFactory::self();
 *
 * QStringList list = factory->formats();
 * QStringList::Iterator it;
 * for ( it = list.begin(); it != list.end(); ++it ) {
 *   KABC::Format *format = factory->format( (*it) );
 *   // do something with format
 * }
 * \endcode
 */
class KABC_EXPORT_DEPRECATED FormatFactory
{
  public:
    /**
      Destructor.
     */
    ~FormatFactory();

    /**
     * Returns the global format factory.
     */
    static FormatFactory *self();

    /**
     * Returns a pointer to a format object or a null pointer
     * if format type doesn't exist.
     *
     * @param type   The type of the format, returned by formats()
     *
     * @see info()
     */
    Format *format( const QString &type );

    /**
     * Returns a list of all available format types.
     */
    QStringList formats();

    /**
     * Returns the info structure for a special type.
     *
     * @param type The type of the format, returned by formats()
     *
     * @see format()
     */
    FormatInfo info( const QString &type ) const;

  protected:
    FormatFactory();

  private:
    class Private;
    Private *const d;
};

}
#endif