kcomponentdata.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 1999 Torben Weis <weis@kde.org>
   Copyright (C) 2007 Matthias Kretz <kretz@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 version 2 as published by the Free Software Foundation.

   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 KCOMPONENTDATA_H
#define KCOMPONENTDATA_H

#include <kdecore_export.h>
#include <ksharedconfig.h>

class QByteArray;
class QString;
class KAboutData;
class KStandardDirs;
class KComponentDataPrivate;

class KDECORE_EXPORT KComponentData // krazy:exclude=dpointer (implicitly shared)
{
public:
    KComponentData();

    KComponentData(const KComponentData&);

    KComponentData &operator=(const KComponentData&);

    bool operator==(const KComponentData&) const;

    bool operator!=(const KComponentData &rhs) const { return !operator==(rhs); }

    enum MainComponentRegistration {
        RegisterAsMainComponent,
        SkipMainComponentRegistration
    };

    explicit KComponentData(const QByteArray &componentName, const QByteArray &catalogName = QByteArray(),
                MainComponentRegistration registerAsMain = RegisterAsMainComponent);

    explicit KComponentData(const KAboutData &aboutData, MainComponentRegistration registerAsMain = RegisterAsMainComponent);
    explicit KComponentData(const KAboutData *aboutData, MainComponentRegistration registerAsMain = RegisterAsMainComponent);

    virtual ~KComponentData();

    bool isValid() const;

    KStandardDirs *dirs() const;

    const KSharedConfig::Ptr &config() const; //krazy:exclude=constref

    const KAboutData *aboutData() const;

    void setAboutData(const KAboutData &aboutData);

    QString componentName() const;

    QString catalogName() const;

protected:
    friend class KApplicationPrivate;

    void setConfigName(const QString &name);

    virtual void virtual_hook( int id, void* data );

private:
    // Ref-counted data
    KComponentDataPrivate* d;
    friend class KComponentDataPrivate;
};

#endif // KCOMPONENTDATA_H