imagecollection.cpp

Go to the documentation of this file.

/* ============================================================
 * File   : imagecollection.cpp
 * Authors: KIPI team developers (see AUTHORS files for details)
 *          
 * Date   : 2004-02
 * Description :
 *
 * Copyright 2004 by the KIPI team
 *
 * This program 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, or (at your option)
 * any later version.
 *
 * This program 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.
 *
 * ============================================================ */

// KDE includes.

#include <kdebug.h>
#include <klocale.h>

// Local includes.
  
#include "imagecollection.h"
#include "imagecollectionshared.h"

QString KIPI::ImageCollection::comment() const
{
    if ( _data )
        return _data->comment();
    else {
        printNullError();
        return QString::null;
    }
}

QString KIPI::ImageCollection::name() const
{
    if ( _data )
        return _data->name();
    else {
        printNullError();
        return QString::null;
    }
}

QString KIPI::ImageCollection::category() const
{
    if ( _data )
        return _data->category();
    else {
        printNullError();
        return QString::null;
    }
}

QDate KIPI::ImageCollection::date() const
{
    if ( _data )
        return _data->date();
    else {
        printNullError();
        return QDate();
    }
}

KURL::List KIPI::ImageCollection::images() const
{
    if ( _data )
        return _data->images();
    else {
        printNullError();
        return KURL::List();
    }
}

KIPI::ImageCollection::ImageCollection( ImageCollectionShared* data )
    : _data( data )
{
}

KIPI::ImageCollection::~ImageCollection()
{
    if ( _data )
        _data->removeRef();
}

KIPI::ImageCollection::ImageCollection( const ImageCollection& rhs )
{
    if ( rhs._data ) {
        _data = rhs._data;
        _data->addRef();
    }
    else
        _data = 0;
}

KIPI::ImageCollection::ImageCollection()
{
    _data = 0;
}

KIPI::ImageCollection& KIPI::ImageCollection::operator=( const KIPI::ImageCollection& rhs )
{
    if ( rhs._data == _data )
        return *this;

    if ( _data )
        _data->removeRef();
    if ( !rhs._data ) {
        printNullError();
        _data = 0;
    }
    else {
        _data = rhs._data;
        _data->addRef();
    }
    return *this;
}

KURL KIPI::ImageCollection::path() const
{
    if ( _data )
        return _data->path();
    else {
        printNullError();
        return KURL();
    }
}

KURL KIPI::ImageCollection::uploadPath() const
{
    if ( _data )
        return _data->uploadPath();
    else {
        printNullError();
        return KURL();
    }
}

KURL KIPI::ImageCollection::uploadRoot() const
{
    if ( _data )
        return _data->uploadRoot();
    else {
        printNullError();
        return KURL();
    }
}

QString KIPI::ImageCollection::uploadRootName() const
{
    if ( _data )
        return _data->uploadRootName();
    else {
        printNullError();
        return QString::null;
    }
}

/*
  Returns whether an imagecollection is a physical folder on the filesystem
  or not. Its important to check this, if your plugin needs to do folder
  based operations for an imagecollection
*/
bool KIPI::ImageCollection::isDirectory() const
{
    if ( _data )
        return _data->isDirectory();
    else {
        printNullError();
        return false;
    }
}

bool KIPI::ImageCollection::isValid() const
{
    return (_data != 0);
}

void KIPI::ImageCollection::printNullError() const
{
    kdWarning( 51000 ) << "Image collection is invalid - this might be the case if you asked for an album, " << endl
                       << "and not album existed. You should check using .isValid() first." << endl
                       << "Notice: Plugins should never create an instance of ImageCollection, only the host application "
                       << "should do that." << endl;
}


bool KIPI::ImageCollection::operator==(const KIPI::ImageCollection& ic) const {
    if (!_data || !(ic._data))
    {
        printNullError();
        return false;
    }
    return *_data == *(ic._data);
}

---