album.h

Go to the documentation of this file.

//==============================================
//  copyright            : (C) 2003 by Will Stokes
//==============================================
//  This program is free software; you can redistribute it 
//  and/or modify it under the terms of the GNU General 
//  Public License as published by the Free Software 
//  Foundation; either version 2 of the License, or  
//  (at your option) any later version.         
//
//  As a special exception, Will Stokes gives permission to 
//  link this program with Qt non-commercial edition, and 
//  distribute the resulting executable, without including the 
//  source code for the Qt non-commercial edition in the 
//  source distribution. 
//==============================================

#ifndef BACKEND_ALBUM_H
#define BACKEND_ALBUM_H

//representative image sizes
#define SMALL 1
#define MEDIUM 2
#define LARGE 3

//define loading success values
#define ALBUM_LOADED 1
#define ALBUM_READ_ERROR 2
#define ALBUM_XML_ERROR 3
#define ALBUM_EXPORTED 1
#define ALBUM_ERROR_OPEN_FILE 2
//--------------------
//forward declarations
class QString;
class QPixmap;
class Subalbum;
class SubalbumPreviewWidget;
class StatusWidget;
//--------------------

//=====================================
//=====================================

class Album
{
//------------------------------------------------------
public:

  Album();

  ~Album();
 
  void setName(QString val);
  
  QString getName();

  void setDescription(QString val);
 
  QString getDescription();

  void setAuthor(QString val);

  QString getAuthor();  

  void setRepresentativeImages(QImage* val);

  QPixmap* getRepresentativeImage(int size);

  Subalbum* getFirstSubalbum();

  Subalbum* getLastSubalbum();

  void appendSubalbum(Subalbum* val);
  
  void removeSubalbum(Subalbum* val);
  
  int getModificationYear();

  int getModificationMonth();

  int getModificationDay();

  void Album::updateCreationDate();
  
  void updateModificationDate();
  
  int importFromDisk(StatusWidget* status, QString fileName);;
  
  int exportToDisk(StatusWidget* status, 
                          bool smallSave, 
                          QString dirName,
                          QString themeName);
  
  int exportToDisk(StatusWidget* status, 
                            bool smallSave, 
                            bool forceSave=false);
  
  bool prevSave();
  
  bool albumModified();

  void setModified(bool val=true);
  
  void syncSubalbumList(SubalbumPreviewWidget* item);
  
  QString getSaveLocation();

  int getNumSubalbums();

  QString getTheme();
//------------------------------------------------------
private:
  int exportToXML();
    
  void exportTopLevelImages();
  
  void exportSubalbumImages(StatusWidget* status, bool smallSave, bool forceSave);

  void reorderSubalbumImages(StatusWidget* status);

  void removeStagnantImages();

  void exportThemeResources( QString theme );
  
  QString name;

  QString description;

  QString author;
  
  QPixmap* smallRepresentativeImage;
  QPixmap* largeRepresentativeImage;

  Subalbum* firstSubalbum;

  Subalbum* lastSubalbum;

  int modificationYear;

  int modificationMonth;

  int modificationDay;
  
  int creationYear;
  
  int creationMonth;
  
  int creationDay;
  
  int numSubalbums;
  
  int numLoadedSubalbums;
  
  bool savedToDisk;
  
  QString saveLocation;
  
  QString theme;  
  
  bool modified;
//------------------------------------------------------
};

#endif //BACKEND_ALBUM_H

---