Album Class Reference

#include <album.h>

Collaboration diagram for Album:

[legend]List of all members.

---

Detailed Description

An album contains Subalbums.

Specific contents:

• Subalbums
• Name
• Description
• Modification date
• Author
• Representative image

Definition at line 55 of file album.h.

Public Member Functions
	Album ()
	Sets default information.
	~Album ()
	Frees Subalbums.
void	setName (QString val)
	Sets the album name.
QString	getName ()
	Gets the album name.
void	setDescription (QString val)
	Sets the album description.
QString	getDescription ()
	Gets the album description.
void	setAuthor (QString val)
	Sets the album author.
QString	getAuthor ()
	Gets the album author.
void	setRepresentativeImages (QImage *val)
	Sets the representative image.
QPixmap *	getRepresentativeImage (int size)
	Returns the representative image.
Subalbum *	getFirstSubalbum ()
	Returns a pointer to the first Subalbum.
Subalbum *	getLastSubalbum ()
	Returns a pointer to the last Subalbum.
void	appendSubalbum (Subalbum *val)
	Appends subalbum to end of linked list.
void	removeSubalbum (Subalbum *val)
	Removes a subalbum.
int	getModificationYear ()
	Returns the last modified year.
int	getModificationMonth ()
	Returns the last modified month.
int	getModificationDay ()
	Returns the last modified day.
void	updateCreationDate ()
	Updates the creation date to today's date.
void	updateModificationDate ()
	Updates the modification date to today's date.
int	importFromDisk (StatusWidget *status, QString fileName)
	Imports album from XML format, returning int indicates success or not.
int	exportToDisk (StatusWidget *status, bool smallSave, QString dirName, QString themeName)
	Exports album in XML and HTML format, along with resized images.
int	exportToDisk (StatusWidget *status, bool smallSave, bool forceSave=false)
	Exports album in XML and HTML format, along with resized images, saves all files to the last saved directory, if none set returns.
bool	prevSave ()
	Returns true if album previously saved to disk.
bool	albumModified ()
	Returns true if album has been modified since the last save operation.
void	setModified (bool val=true)
	Sets the album as modified.
void	syncSubalbumList (SubalbumPreviewWidget *item)
	Syncs subalbum ordering with front end gui ordering.
QString	getSaveLocation ()
	Returns the current save location of all images.
int	getNumSubalbums ()
	Returns number of subalbums.
QString	getTheme ()
	Returns currently selected theme.
Private Member Functions
int	exportToXML ()
	Exports album to XML.
void	exportTopLevelImages ()
	Exports top level images.
void	exportSubalbumImages (StatusWidget *status, bool smallSave, bool forceSave)
	Exports subalbum images.
void	reorderSubalbumImages (StatusWidget *status)
	Checks if images need to be moved and does so if necessary.
void	removeStagnantImages ()
	Removes old stagnant images caused when photos are removed from album or moved from one subalbum to another.
void	exportThemeResources (QString theme)
	Removes previously saved resources, copies over new resources.
Private Attributes
QString	name
	Short name for album.
QString	description
	Longer description of album.
QString	author
	Album Creator.
QPixmap *	smallRepresentativeImage
	Representative images.
QPixmap *	largeRepresentativeImage
Subalbum *	firstSubalbum
	Pointer to first Subalbum.
Subalbum *	lastSubalbum
	Pointer to last Subalbum.
int	modificationYear
	Last modification year.
int	modificationMonth
	Last modification month.
int	modificationDay
	Last modification day.
int	creationYear
	Creation year.
int	creationMonth
	Creation month.
int	creationDay
	Creation day.
int	numSubalbums
	Number of subalbums.
int	numLoadedSubalbums
	Number of loaded subalbums.
bool	savedToDisk
	Set if album was loaded/has been saved to disk.
QString	saveLocation
	Directory album saved to.
QString	theme
	Theme to save album with.
bool	modified
	Modification status of the album.

---

Constructor & Destructor Documentation

Album::Album (   )

Sets default information. Definition at line 44 of file album.cpp. References author, description, firstSubalbum, IMAGE_PATH, largeRepresentativeImage, lastSubalbum, modified, name, numLoadedSubalbums, numSubalbums, savedToDisk, saveLocation, smallRepresentativeImage, theme, and updateCreationDate(). { //set strings to default values name = ""; description =""; author = ""; theme = "Classic"; //by default no representative image smallRepresentativeImage = new QPixmap( QString(IMAGE_PATH)+"notSpecified.png" ); largeRepresentativeImage = NULL; //no Subalbums by default firstSubalbum = NULL; lastSubalbum = NULL; //set the creation date to today updateCreationDate(); //no subalbums numSubalbums = 0; numLoadedSubalbums = 0; //not previously saved by default savedToDisk = false; //no interesting modifications yet modified = false; //construct temp directory to save images to QDir rootDir( QDir::homeDirPath() ); if(!rootDir.exists( ".albumShaper" )) { rootDir.mkdir( ".albumShaper" ); } rootDir.cd( ".albumShaper" ); if(!rootDir.exists( "tmp" )) { rootDir.mkdir( "tmp" ); } saveLocation = QDir::homeDirPath() + "/.albumShaper/tmp"; }

Album::~Album (   )

Frees Subalbums. Definition at line 89 of file album.cpp. References firstSubalbum, Subalbum::getNext(), largeRepresentativeImage, and smallRepresentativeImage. { //delete representative image delete smallRepresentativeImage; delete largeRepresentativeImage; //delete subalbums Subalbum* current = firstSubalbum; Subalbum* temp; while(current != NULL) { temp = current->getNext(); delete current; current = temp; } }

---

Member Function Documentation

bool Album::albumModified (   )

Returns true if album has been modified since the last save operation. Definition at line 1036 of file album.cpp. References modified. Referenced by Window::closeEvent(), TitleWidget::loadAlbum(), and TitleWidget::newAlbum(). { return modified; }

void Album::appendSubalbum (  Subalbum *  val  )

Appends subalbum to end of linked list. Definition at line 215 of file album.cpp. References firstSubalbum, lastSubalbum, modified, numSubalbums, and Subalbum::setNext(). Referenced by SubalbumsWidget::createAction(), and importFromDisk(). { numSubalbums++; //first subalbum if(firstSubalbum == NULL) { firstSubalbum = val; lastSubalbum = val; } //append to end of list else { lastSubalbum->setNext( val ); lastSubalbum = val; } //set modified modified = true; }

void Album::exportSubalbumImages (  StatusWidget *  status, bool  smallSave, bool  forceSave )  [private]

Exports subalbum images. Definition at line 657 of file album.cpp. References copyFile(), firstSubalbum, Subalbum::getFirst(), Photo::getImage(), Photo::getImageFilename(), Photo::getInitialPhotoNumber(), Photo::getInitialSubalbumNumber(), getMD5(), Photo::getNeedsSavingVal(), Subalbum::getNext(), Photo::getNext(), Photo::getSlideshowFilename(), StatusWidget::incrementProgress(), saveLocation, Photo::setImageChecksum(), Photo::setImageFilename(), Photo::setNeedsSavingVal(), Photo::setSlideshowChecksum(), Photo::setSlideshowFilename(), Photo::setThumbnailChecksum(), Photo::setThumbnailFilename(), and THUMBNAIL. Referenced by exportToDisk(). { //iterate over all subalbums int subalbumNumber=0; Subalbum* currentSubalbum = firstSubalbum; while(currentSubalbum != NULL) { subalbumNumber++; //iterate over all photos in this subalbum int photoNumber=0; Photo* currentPhoto = currentSubalbum->getFirst(); while(currentPhoto != NULL) { photoNumber++; //--------------------------------------- //if the current photo does not need to be saved then move on if( !forceSave && !currentPhoto->getNeedsSavingVal() ) { currentPhoto = currentPhoto->getNext(); status->incrementProgress(); qApp->processEvents(); continue; } //--------------------------------------- //construct a QDir object for the tmp folder QDir rootDir; //--------------------------------------- //get initial photo # and subalbum #, used for saving int initPhotoNumber = currentPhoto->getInitialPhotoNumber(); int initSubalbumNumber = currentPhoto->getInitialSubalbumNumber(); //--------------------------------------- //export thumbnail image QString fileName = QString(saveLocation + "/img/%1/%2_thumb.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); currentPhoto->getImage(THUMBNAIL)->save(fileName, "JPEG", 100); //compute and store md5 for thumbnail std::ifstream thumbnailFile(fileName.ascii()); if(thumbnailFile.is_open()) { currentPhoto->setThumbnailChecksum( getMD5(thumbnailFile) ); thumbnailFile.close(); } //--------------------------------------- //export slideshow image QString oldName = currentPhoto->getSlideshowFilename(); QString newName = QString(saveLocation + "/img/%1/%2_slideshow.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); //if file has been modified move from current location to final location if( currentPhoto->getNeedsSavingVal() ) { //attempt to rename file, if fails do explicit copy, then delete prev file if(!rootDir.rename( oldName, newName)) { copyFile(oldName, newName); rootDir.remove(oldName); } } //If file has not been modified we must be doing a save-as and saving has been forced. In this case //COPY file from current location to final location, DON'T delete previous copy!!! else { copyFile(oldName, newName); } //compute and store md5 for slideshow image std::ifstream file(newName.ascii()); if(file.is_open()) { currentPhoto->setSlideshowChecksum( getMD5(file) ); file.close(); } //--------------------------------------- //export full size image, skip is doing small save if(!smallSave) { oldName = currentPhoto->getImageFilename(); newName = QString(saveLocation + "/img/%1/%2.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); //if file has been modified move from current location to final location if( currentPhoto->getNeedsSavingVal() ) { //attempt to rename file, if fails do explicit copy, then delete prev file if(!rootDir.rename( oldName, newName)) { copyFile(oldName, newName); rootDir.remove(oldName); } } //If file has not been modified we must be doing a save-as and saving has been forced. In this case //COPY file from current location to final location, DON'T delete previous copy!!! else { copyFile(oldName, newName); } //compute and store md5 for image std::ifstream imageFile(newName.ascii()); if(imageFile.is_open()) { currentPhoto->setImageChecksum( getMD5(imageFile) ); imageFile.close(); } } //--------------------------------------- //set new storage locations of files (skip if doing small save since large photo not exported) if(!smallSave) { currentPhoto->setImageFilename( QString(saveLocation + "/img/%1/%2.jpg").arg(initSubalbumNumber).arg(initPhotoNumber) ); currentPhoto->setSlideshowFilename( QString(saveLocation + "/img/%1/%2_slideshow.jpg").arg(initSubalbumNumber).arg(initPhotoNumber) ); currentPhoto->setThumbnailFilename( QString(saveLocation + "/img/%1/%2_thumb.jpg").arg(initSubalbumNumber).arg(initPhotoNumber) ); } //--------------------------------------- //set image as not needing saving (skip if doing small save since large photo not exported) if(!smallSave) currentPhoto->setNeedsSavingVal(false); //--------------------------------------- //update progress bar status->incrementProgress(); qApp->processEvents(); //--------------------------------------- //move on to next photo in subalbum currentPhoto = currentPhoto->getNext(); //--------------------------------------- } //--------------------------------------- //move on to next subalbum currentSubalbum = currentSubalbum->getNext(); } }

void Album::exportThemeResources (  QString  theme  )  [private]

Removes previously saved resources, copies over new resources. Definition at line 1006 of file album.cpp. References copyFile(), saveLocation, and THEMES_PATH. Referenced by exportToDisk(). { //create resources directory if it doesn't exist QDir localDir(saveLocation); localDir.mkdir("resources"); localDir.setPath(saveLocation + "/resources"); //remove all files in this directory from previous saves with other themes QStringList list = localDir.entryList( QDir::Files ); QStringList::Iterator file; for ( file = list.begin(); file != list.end(); ++file ) { localDir.remove( saveLocation + "/resources/" + *file ); } //copy resource files over from theme's resources directory localDir.setPath(THEMES_PATH + theme + "/resources"); list = localDir.entryList( QDir::Files ); for ( file = list.begin(); file != list.end(); ++file ) { copyFile( THEMES_PATH + theme + "/resources/" + *file, saveLocation + "/resources/" + *file); } }

int Album::exportToDisk (  StatusWidget *  status, bool  smallSave, bool  forceSave = false )

Exports album in XML and HTML format, along with resized images, saves all files to the last saved directory, if none set returns. Definition at line 482 of file album.cpp. References ALBUM_EXPORTED, exportSubalbumImages(), exportThemeResources(), exportTopLevelImages(), exportToXML(), firstSubalbum, Subalbum::getNext(), Subalbum::getNumPhotos(), modified, numSubalbums, removeStagnantImages(), reorderSubalbumImages(), savedToDisk, saveLocation, StatusWidget::setStatus(), StatusWidget::showProgressBar(), theme, and transformXMLtoHTML(). { //------------------------------------------ //create subdirs QDir localDir(saveLocation); //img dirs localDir.mkdir("img"); //subalbum dirs localDir.setPath(saveLocation + "/img"); int i; for(i=1; i <= numSubalbums; i++) { QString dirName = QString("%1") .arg(i); localDir.mkdir(dirName); } //------------------------------------------ //checks worked, go ahead with export //count number of photos int totalPhotos=0; Subalbum* current = firstSubalbum; while(current != NULL) { totalPhotos+=current->getNumPhotos(); current = current->getNext(); } //setup progress bar status->showProgressBar( "Saving:", 3*totalPhotos ); qApp->processEvents(); //copy over theme resources exportThemeResources( theme ); //export album cover image, subalbum thumbnails exportTopLevelImages(); //export subalbum images (thumbnail, slideshow, and full versions of all images) exportSubalbumImages(status, smallSave, forceSave); //apply reordering to all images reorderSubalbumImages(status); //remove old images that nolonger belong removeStagnantImages(); //remove previous html files localDir.setPath(saveLocation); QStringList list = localDir.entryList( QDir::Files ); QStringList::Iterator file; for ( file = list.begin(); file != list.end(); ++file ) { if((*file).endsWith(".html")) localDir.remove( saveLocation + "/" + *file ); } //export xml structure of album if(!smallSave) { int result = exportToXML(); if(result != ALBUM_EXPORTED) return result; } //export various html pages using selected theme transformXMLtoHTML( saveLocation, theme ); //------------------------------------------ //remove files from temp folder QDir tmpDir(QDir::homeDirPath() + "/.albumShaper/tmp" ); QStringList strLst = tmpDir.entryList(); QStringList::iterator it; for(it = strLst.begin(); it != strLst.end(); it++) { tmpDir.remove(*it); } //------------------------------------------ savedToDisk = true; //just saved so no modifications since last save modified = false; //hide progress bar status->setStatus( "Album saved." ); //------------------------------------------ return ALBUM_EXPORTED; }

int Album::exportToDisk (  StatusWidget *  status, bool  smallSave, QString  dirName, QString  themeName )

Exports album in XML and HTML format, along with resized images. Definition at line 465 of file album.cpp. References saveLocation, and theme. Referenced by TitleWidget::saveAlbum(), and TitleWidget::saveAsAlbum(). { //check to see if save location has actually changed, if not don't force save images //this occurs when user blindly selects the same old spot, or is just changing the theme used by default bool forceSave = true; if(saveLocation == dirName) forceSave = false; saveLocation = dirName; theme = themeName; return exportToDisk(status, smallSave, forceSave); }

void Album::exportTopLevelImages (   )  [private]

Exports top level images. Definition at line 621 of file album.cpp. References firstSubalbum, Subalbum::getNext(), Subalbum::getRepresentativeImage(), getRepresentativeImage(), LARGE, and saveLocation. Referenced by exportToDisk(). { //if image set export it if(getRepresentativeImage(LARGE) != NULL) { getRepresentativeImage(LARGE)->save(saveLocation + "/img/album.jpg", "JPEG", 100); } //else make sure any previously set images are removed else { QDir rootDir(saveLocation + "/img/"); rootDir.remove("album.jpg"); } //export subalbum thumbs int n=0; Subalbum* current = firstSubalbum; while(current != NULL) { n++; //if subalbum has representative image export it if(current->getRepresentativeImage(LARGE) != NULL ) { QString fileName = QString(saveLocation + "/img/%1_thumb.jpg" ).arg(n); current->getRepresentativeImage(LARGE)->save(fileName, "JPEG", 100); } //otherwise make sure anyprevious set images are removed else { QDir rootDir(saveLocation + "/img/"); rootDir.remove( QString("%1_thumb.jpg").arg(n) ); } current = current->getNext(); } }

int Album::exportToXML (   )  [private]

Exports album to XML. Definition at line 572 of file album.cpp. References ALBUM_ERROR_OPEN_FILE, ALBUM_EXPORTED, author, creationDay, creationMonth, creationYear, description, Subalbum::exportToXML(), firstSubalbum, fixXMLString(), Subalbum::getNext(), getRepresentativeImage(), LARGE, modificationDay, modificationMonth, modificationYear, name, saveLocation, SLIDESHOW_HEIGHT, SLIDESHOW_WIDTH, theme, THUMBNAIL_HEIGHT, THUMBNAIL_WIDTH, and updateModificationDate(). Referenced by exportToDisk(). { //update modification date updateModificationDate(); //create/open xml file QFile* xml = new QFile(saveLocation + "/Album.xml"); if(xml->open(IO_WriteOnly)) { QTextStream stream( xml ); //write album information stream << "<?xml version=\"1.0\"?>\n"; stream << "<album version=\"1.1\">\n"; stream << " <name>" << fixXMLString(name) << "</name>\n"; stream << " <description>" << fixXMLString(description) << "</description>\n"; stream << " <author>" << fixXMLString(author) << "</author>\n"; stream << " <created>" << creationYear << " " << creationMonth << " " << creationDay << "</created>\n"; stream << " <modified>" << modificationYear << " " << modificationMonth << " " << modificationDay << "</modified>\n"; stream << " <theme>" << theme << "</theme>\n"; stream << " <thumbnailDimensions>" << THUMBNAIL_WIDTH << " " << THUMBNAIL_HEIGHT << "</thumbnailDimensions>\n"; stream << " <slideshowDimensions>" << SLIDESHOW_WIDTH << " " << SLIDESHOW_HEIGHT << "</slideshowDimensions>\n"; //if album has a represenatative image save it's path if(getRepresentativeImage(LARGE) != NULL ) { stream << " <thumb path=\"img/album.jpg\"/>\n"; } //write subalbums Subalbum* current = firstSubalbum; while(current != NULL) { current->exportToXML(stream); current = current->getNext(); } //end album stream << "</album>\n"; xml->close(); return ALBUM_EXPORTED; } else { return ALBUM_ERROR_OPEN_FILE; } }

QString Album::getAuthor (   )

Gets the album author. Definition at line 149 of file album.cpp. References author. Referenced by TitleWidget::refresh(). { return QString(author); }

QString Album::getDescription (   )

Gets the album description. Definition at line 133 of file album.cpp. References description. Referenced by TitleWidget::refresh(). { return QString(description); }

Subalbum * Album::getFirstSubalbum (   )

Returns a pointer to the first Subalbum. Definition at line 204 of file album.cpp. References firstSubalbum. Referenced by AlbumStatistics::AlbumStatistics(), and SubalbumsWidget::refresh(). { return firstSubalbum; }

Subalbum * Album::getLastSubalbum (   )

Returns a pointer to the last Subalbum. Definition at line 210 of file album.cpp. References lastSubalbum. { return lastSubalbum; }

int Album::getModificationDay (   )

Returns the last modified day. Definition at line 286 of file album.cpp. References modificationDay. { return modificationDay; }

int Album::getModificationMonth (   )

Returns the last modified month. Definition at line 280 of file album.cpp. References modificationMonth. { return modificationMonth; }

int Album::getModificationYear (   )

Returns the last modified year. Definition at line 274 of file album.cpp. References modificationYear. { return modificationYear; }

QString Album::getName (   )

Gets the album name. Definition at line 117 of file album.cpp. References name. Referenced by TitleWidget::refresh(), and TitleWidget::saveAsAlbum(). { return QString(name); }

int Album::getNumSubalbums (   )

Returns number of subalbums. Definition at line 1071 of file album.cpp. References numSubalbums. Referenced by SubalbumsWidget::createAction(). { return numSubalbums; }

QPixmap * Album::getRepresentativeImage (  int  size  )

Returns the representative image. Definition at line 193 of file album.cpp. References LARGE, largeRepresentativeImage, SMALL, and smallRepresentativeImage. Referenced by exportTopLevelImages(), exportToXML(), TitleWidget::refresh(), TitleWidget::setImageAction(), and TitleWidget::TitleWidget(). { if(size == SMALL) return smallRepresentativeImage; else if(size == LARGE) return largeRepresentativeImage; else return NULL; }

QString Album::getSaveLocation (   )

Returns the current save location of all images. Definition at line 1066 of file album.cpp. References saveLocation. Referenced by TitleWidget::saveAsAlbum(). { return saveLocation; }

QString Album::getTheme (   )

Returns currently selected theme. Definition at line 1076 of file album.cpp. References theme. Referenced by TitleWidget::saveAsAlbum(). { return QString(theme); }

int Album::importFromDisk (  StatusWidget *  status, QString  fileName )

Imports album from XML format, returning int indicates success or not. Definition at line 311 of file album.cpp. References ALBUM_LOADED, ALBUM_READ_ERROR, ALBUM_XML_ERROR, appendSubalbum(), author, creationDay, creationMonth, creationYear, description, Subalbum::importFromDisk(), name, numLoadedSubalbums, numSubalbums, savedToDisk, saveLocation, setRepresentativeImages(), StatusWidget::setStatus(), StatusWidget::showProgressBar(), theme, and updateXML(). Referenced by TitleWidget::loadAlbum(). { //update file updateXML( QFileInfo(fileName).dirPath(TRUE) ); //open file QFile albumFile( fileName ); //unable ot open xml file? alert user if( !albumFile.open( IO_ReadOnly ) ) return ALBUM_READ_ERROR; //parse dom QDomDocument albumDom; if( !albumDom.setContent( &albumFile ) ) return ALBUM_XML_ERROR; //close file albumFile.close(); //get main directory all other files and subdirectories are in QString rootDir = QFileInfo(albumFile).dirPath(TRUE); saveLocation = rootDir + "/img"; //if representative image exists load QImage repImage(rootDir + "/img/album.jpg"); if(!repImage.isNull()) { setRepresentativeImages(&repImage); } //count number of photos in album, needed for showing loading progress int numPhotos = 0; QDomElement root = albumDom.documentElement(); QDomNode node = root.firstChild(); while( !node.isNull() ) { if( node.isElement() && node.nodeName() == "subalbum" ) { QDomNode childNode = node.firstChild(); while( !childNode.isNull() ) { if( childNode.isElement() && childNode.nodeName() == "photo" ) numPhotos++; childNode = childNode.nextSibling(); } } node = node.nextSibling(); } //setup progress bar status->showProgressBar( "Loading:", numPhotos ); qApp->processEvents(); int subalbumNum = 0; //get root node and start parsing DOM root = albumDom.documentElement(); node = root.firstChild(); QDomText val; while( !node.isNull() ) { //------------------------------------------------------------ //album name if( node.isElement() && node.nodeName() == "name" ) { val = node.firstChild().toText(); if(!val.isNull()) name = val.nodeValue(); } //------------------------------------------------------------ //album description else if( node.isElement() && node.nodeName() == "description" ) { val = node.firstChild().toText(); if(!val.isNull()) description = val.nodeValue(); } //------------------------------------------------------------ //album author else if( node.isElement() && node.nodeName() == "author" ) { val = node.firstChild().toText(); if(!val.isNull()) author = val.nodeValue(); } //------------------------------------------------------------ //album theme else if( node.isElement() && node.nodeName() == "theme" ) { val = node.firstChild().toText(); if(!val.isNull()) theme = val.nodeValue(); } //------------------------------------------------------------ //album creation date else if( node.isElement() && node.nodeName() == "created" ) { val = node.firstChild().toText(); //split value based on spaces, should be 7 fields QStringList vals = QStringList::split( QRegExp(" "), val.nodeValue() ); int i=0; int intVals[3]; QStringList::Iterator it; for ( it = vals.begin(); it != vals.end(); ++it ) { intVals[i] = QString(*it).toInt(); i++; //only read first 3 entires, year/month/day, don't overwrite //buffer on addition entries if xml messed up if(i > 2) break; } creationYear = intVals[0]; creationMonth = intVals[1]; creationDay = intVals[2]; } //------------------------------------------------------------ //subalbum else if( node.isElement() && node.nodeName() == "subalbum" ) { //increase counter subalbumNum++; //create new subalbum Subalbum* salbum = new Subalbum(this, numSubalbums+1); //populate it salbum->importFromDisk( &node, subalbumNum, status, (rootDir + "/") ); //append it to list of subalbums appendSubalbum(salbum); } //------------------------------------------------------------ //advance to next node node = node.nextSibling(); //------------------------------------------------------------ } //reset number of loaded subalbums numLoadedSubalbums = numSubalbums; //hide progress bar status->setStatus( "Album loaded." ); //save load directory name and loaded/saved bit saveLocation = rootDir; savedToDisk = true; return ALBUM_LOADED; }

bool Album::prevSave (   )

Returns true if album previously saved to disk. Definition at line 1031 of file album.cpp. References savedToDisk. Referenced by TitleWidget::saveAlbum(), and TitleWidget::saveAsAlbum(). { return savedToDisk; }

void Album::removeStagnantImages (   )  [private]

Removes old stagnant images caused when photos are removed from album or moved from one subalbum to another. Definition at line 944 of file album.cpp. References firstSubalbum, Subalbum::getNext(), Subalbum::getNumLoadedPhotos(), Subalbum::getNumPhotos(), numLoadedSubalbums, numSubalbums, Subalbum::resetNumLoadedPhotos(), and saveLocation. Referenced by exportToDisk(). { QDir rootDir(saveLocation + "/img/"); //--------------------------------- //remove stagnant photos in existing subalbums int subalbumNumber=0; Subalbum* currentSubalbum = firstSubalbum; while(currentSubalbum != NULL) { subalbumNumber++; int i; for(i=currentSubalbum->getNumPhotos() + 1; i <= currentSubalbum->getNumLoadedPhotos(); i++) { QString thumbString = QString(saveLocation + "/img/%1/%2_thumb.jpg" ).arg(subalbumNumber).arg(i); QString slideshowString = QString(saveLocation + "/img/%1/%2_slideshow.jpg" ).arg(subalbumNumber).arg(i); QString imageString = QString(saveLocation + "/img/%1/%2.jpg" ).arg(subalbumNumber).arg(i); rootDir.remove(thumbString); rootDir.remove(slideshowString); rootDir.remove(imageString); } //reset number of loaded photos since old photos removed now currentSubalbum->resetNumLoadedPhotos(); //move on to next subalbum currentSubalbum = currentSubalbum->getNext(); } //--------------------------------- //remove stagnant subalbums and all their contents int i; for(i=numSubalbums+1; i<=numLoadedSubalbums; i++) { //get filelist for directory QDir imageDir( QString(saveLocation + "/img/%1/").arg(i) ); QStringList list = imageDir.entryList( QDir::Files ); //remove each file in directory QStringList::Iterator file; for ( file = list.begin(); file != list.end(); ++file ) { rootDir.remove( QString(saveLocation + "/img/%1/" + *file).arg(i) ); } //remove directory rootDir.rmdir( QString("%1").arg(i) ); //remove thumbnail image rootDir.remove( QString(saveLocation + "/img/%1_thumb.jpg").arg(i) ); //remove slideshow and thumbnail html pages rootDir.remove( QString(saveLocation + "/subalbum_%1_thumbs.html").arg(i) ); rootDir.remove( QString(saveLocation + "/subalbum_%1_slideshow.html").arg(i) ); } //reset number of loaded subalbums since stagnant directories removed now numLoadedSubalbums = numSubalbums; //--------------------------------- }

void Album::removeSubalbum (  Subalbum *  val  )

Removes a subalbum. Definition at line 236 of file album.cpp. References firstSubalbum, Subalbum::getNext(), lastSubalbum, modified, numSubalbums, and Subalbum::setNext(). Referenced by SubalbumsWidget::deleteAction(). { //search through linked list and remove item Subalbum* prev = NULL; Subalbum* current = firstSubalbum; while(current != NULL) { //found it! remove it if(current == val) { //update first pointer if(firstSubalbum == val) firstSubalbum = val->getNext(); //update last pointer if(lastSubalbum == val) lastSubalbum = prev; //update next pointer if(prev != NULL) prev->setNext( current->getNext() ); //delete object delete val; val = NULL; numSubalbums--; return; } prev = current; current = current->getNext(); } //set modified modified = true; }

void Album::reorderSubalbumImages (  StatusWidget *  status  )  [private]

Checks if images need to be moved and does so if necessary. Definition at line 788 of file album.cpp. References copyFile(), firstSubalbum, Subalbum::getFirst(), Photo::getInitialPhotoNumber(), Photo::getInitialSubalbumNumber(), Subalbum::getNext(), Photo::getNext(), StatusWidget::incrementProgress(), saveLocation, Photo::setImageFilename(), Photo::setInitialPhotoNumber(), Photo::setInitialSubalbumNumber(), Photo::setSlideshowFilename(), and Photo::setThumbnailFilename(). Referenced by exportToDisk(). { //-------------------------------------------------------- //-------------------------------------------------------- //first pass over all photos, those whose initial and current numbers don't match up //rename slightly so we don't overwrte them the second time around //-------------------------------------------------------- //-------------------------------------------------------- //iterate over all subalbums int subalbumNumber=0; Subalbum* currentSubalbum = firstSubalbum; while(currentSubalbum != NULL) { subalbumNumber++; //iterate over all photos in this subalbum int photoNumber=0; Photo* currentPhoto = currentSubalbum->getFirst(); while(currentPhoto != NULL) { photoNumber++; //--------------------------------------- //get initial photo # and subalbum #, used for checks and moving int initPhotoNumber = currentPhoto->getInitialPhotoNumber(); int initSubalbumNumber = currentPhoto->getInitialSubalbumNumber(); //--------------------------------------- //if the current photo has not moved then move on if( initPhotoNumber == photoNumber && initSubalbumNumber == subalbumNumber) { currentPhoto = currentPhoto->getNext(); status->incrementProgress(); qApp->processEvents(); continue; } //--------------------------------------- //rename full image, slideshow image, and thumbnail image QDir rootDir; QString oldName = QString(saveLocation + "/img/%1/%2.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); QString newName = QString(saveLocation + "/img/%1/%2_moved.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); if(!rootDir.rename( oldName, newName)) { copyFile(oldName, newName); rootDir.remove( oldName ); } //----- oldName = QString(saveLocation + "/img/%1/%2_slideshow.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); newName = QString(saveLocation + "/img/%1/%2_slideshow_moved.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); if(!rootDir.rename( oldName, newName)) { copyFile(oldName, newName); rootDir.remove( oldName ); } //----- oldName = QString(saveLocation + "/img/%1/%2_thumb.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); newName = QString(saveLocation + "/img/%1/%2_thumb_moved.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); if(!rootDir.rename( oldName, newName)) { copyFile(oldName, newName); rootDir.remove( oldName ); } //--------------------------------------- //update progress bar status->incrementProgress(); qApp->processEvents(); //--------------------------------------- //move on to next photo in subalbum currentPhoto = currentPhoto->getNext(); //--------------------------------------- } //--------------------------------------- //move on to next subalbum currentSubalbum = currentSubalbum->getNext(); } //-------------------------------------------------------- //-------------------------------------------------------- //second pass over all photos, those whose initial and current numbers don't match up //rename to their final names and reset initial photo and subalbum numbers //-------------------------------------------------------- //-------------------------------------------------------- //iterate over all subalbums subalbumNumber=0; currentSubalbum = firstSubalbum; while(currentSubalbum != NULL) { subalbumNumber++; //iterate over all photos in this subalbum int photoNumber=0; Photo* currentPhoto = currentSubalbum->getFirst(); while(currentPhoto != NULL) { photoNumber++; //--------------------------------------- //get initial photo # and subalbum #, used for checks and moving int initPhotoNumber = currentPhoto->getInitialPhotoNumber(); int initSubalbumNumber = currentPhoto->getInitialSubalbumNumber(); //--------------------------------------- //if the current photo has not moved then move on if( initPhotoNumber == photoNumber && initSubalbumNumber == subalbumNumber) { currentPhoto = currentPhoto->getNext(); status->incrementProgress(); qApp->processEvents(); continue; } //--------------------------------------- //rename full image, slideshow image, and thumbnail image to their final names QDir rootDir; QString oldName = QString(saveLocation + "/img/%1/%2_moved.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); QString newName = QString(saveLocation + "/img/%1/%2.jpg" ).arg(subalbumNumber).arg(photoNumber); if(!rootDir.rename( oldName, newName)) { copyFile(oldName, newName); rootDir.remove( oldName ); } //----- oldName = QString(saveLocation + "/img/%1/%2_slideshow_moved.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); newName = QString(saveLocation + "/img/%1/%2_slideshow.jpg" ).arg(subalbumNumber).arg(photoNumber); if(!rootDir.rename( oldName, newName)) { copyFile(oldName, newName); rootDir.remove( oldName ); } //----- oldName = QString(saveLocation + "/img/%1/%2_thumb_moved.jpg" ).arg(initSubalbumNumber).arg(initPhotoNumber); newName = QString(saveLocation + "/img/%1/%2_thumb.jpg" ).arg(subalbumNumber).arg(photoNumber); if(!rootDir.rename( oldName, newName)) { copyFile(oldName, newName); rootDir.remove( oldName ); } //--------------------------------------- //reset initial photo and subalbum numbers, and filenames currentPhoto->setInitialPhotoNumber(photoNumber); currentPhoto->setInitialSubalbumNumber(subalbumNumber); currentPhoto->setImageFilename( QString(saveLocation + "/img/%1/%2.jpg").arg(subalbumNumber).arg(photoNumber) ); currentPhoto->setSlideshowFilename( QString(saveLocation + "/img/%1/%2_slideshow.jpg").arg(subalbumNumber).arg(photoNumber) ); currentPhoto->setThumbnailFilename( QString(saveLocation + "/img/%1/%2_thumb.jpg").arg(subalbumNumber).arg(photoNumber) ); //--------------------------------------- //update progress bar status->incrementProgress(); qApp->processEvents(); //--------------------------------------- //move on to next photo in subalbum currentPhoto = currentPhoto->getNext(); //--------------------------------------- } //--------------------------------------- //move on to next subalbum currentSubalbum = currentSubalbum->getNext(); } }

void Album::setAuthor (  QString  val  )

Sets the album author. Definition at line 139 of file album.cpp. References author, and modified. Referenced by TitleWidget::updateAuthor(). { if(author != val) { author = val; modified = true; } }

void Album::setDescription (  QString  val  )

Sets the album description. Definition at line 123 of file album.cpp. References description, and modified. Referenced by TitleWidget::updateDescription(). { if(description != val) { description = val; modified = true; } }

void Album::setModified (  bool  val = true  )

Sets the album as modified. Definition at line 1081 of file album.cpp. References modified. Referenced by Subalbum::addPhoto(), Subalbum::lazyAddPhoto(), TitleWidget::loadAlbum(), TitleWidget::newAlbum(), Subalbum::photoMoved(), Subalbum::removePhoto(), Subalbum::setDescription(), Subalbum::setModified(), Subalbum::setName(), Subalbum::setNext(), and Subalbum::setRepresentativeImages(). { modified = val; }

void Album::setName (  QString  val  )

Sets the album name. Definition at line 107 of file album.cpp. References modified, and name. Referenced by TitleWidget::updateName(). { if(name != val) { name = val; modified = true; } }

void Album::setRepresentativeImages (  QImage *  val  )

Sets the representative image. Definition at line 155 of file album.cpp. References largeRepresentativeImage, modified, resizeImage(), and smallRepresentativeImage. Referenced by importFromDisk(), and TitleWidget::setImageAction(). { //--------------------------------------------------------- //delete representative images delete smallRepresentativeImage; delete largeRepresentativeImage; //--------------------------------------------------------- //compute representative image sizes int smallRepWidth = 0; int smallRepHeight = 0; int largeRepWidth = 0; int largeRepHeight = 0; resizeImage( rawImage->width(), rawImage->height(), 107, 80, smallRepWidth, smallRepHeight); resizeImage( rawImage->width(), rawImage->height(), 500, 320, largeRepWidth, largeRepHeight); //--------------------------------------------------------- //create various representative images //--------------------------------------------------------- //copy and scale small version QImage thumbnailSmall = rawImage->smoothScale( smallRepWidth, smallRepHeight ); thumbnailSmall.setAlphaBuffer(true); smallRepresentativeImage = new QPixmap( smallRepWidth, smallRepHeight ); smallRepresentativeImage->convertFromImage( thumbnailSmall ); //copy and scale large version QImage thumbnailLarge = rawImage->smoothScale( largeRepWidth, largeRepHeight ); thumbnailLarge.setAlphaBuffer(true); largeRepresentativeImage = new QPixmap( largeRepWidth, largeRepHeight ); largeRepresentativeImage->convertFromImage( thumbnailLarge ); //set modified modified = true; }

void Album::syncSubalbumList (  SubalbumPreviewWidget *  item  )

Syncs subalbum ordering with front end gui ordering. Definition at line 1041 of file album.cpp. References firstSubalbum, SubalbumPreviewWidget::getSubalbum(), lastSubalbum, and Subalbum::setNext(). Referenced by SubalbumsWidget::reorder(). { //base case, no items if(item == NULL) { firstSubalbum = NULL; lastSubalbum = NULL; return; } //set first and last pointers firstSubalbum = item->getSubalbum(); firstSubalbum->setNext(NULL); lastSubalbum = firstSubalbum; //set all next pointers while(item->nextItem() != NULL) { item->getSubalbum()->setNext( ((SubalbumPreviewWidget*)item->nextItem())->getSubalbum() ); item = (SubalbumPreviewWidget*)item->nextItem(); lastSubalbum = item->getSubalbum(); lastSubalbum->setNext(NULL); } }

void Album::updateCreationDate (   )

Updates the creation date to today's date. Definition at line 292 of file album.cpp. References creationDay, creationMonth, and creationYear. Referenced by Album(). { //set creation date to today QDate date = QDate::currentDate(); creationYear = date.year(); creationMonth = date.month(); creationDay = date.day(); }

void Album::updateModificationDate (   )

Updates the modification date to today's date. Definition at line 302 of file album.cpp. References modificationDay, modificationMonth, and modificationYear. Referenced by exportToXML(). { //set last modification date to today QDate date = QDate::currentDate(); modificationYear = date.year(); modificationMonth = date.month(); modificationDay = date.day(); }

---

Member Data Documentation

QString Album::author [private]

Album Creator. Definition at line 180 of file album.h. Referenced by Album(), exportToXML(), getAuthor(), importFromDisk(), and setAuthor().

int Album::creationDay [private]

Creation day. Definition at line 208 of file album.h. Referenced by exportToXML(), importFromDisk(), and updateCreationDate().

int Album::creationMonth [private]

Creation month. Definition at line 205 of file album.h. Referenced by exportToXML(), importFromDisk(), and updateCreationDate().

int Album::creationYear [private]

Creation year. Definition at line 202 of file album.h. Referenced by exportToXML(), importFromDisk(), and updateCreationDate().

QString Album::description [private]

Longer description of album. Definition at line 177 of file album.h. Referenced by Album(), exportToXML(), getDescription(), importFromDisk(), and setDescription().

Subalbum* Album::firstSubalbum [private]

Pointer to first Subalbum. Definition at line 187 of file album.h. Referenced by Album(), appendSubalbum(), exportSubalbumImages(), exportToDisk(), exportTopLevelImages(), exportToXML(), getFirstSubalbum(), removeStagnantImages(), removeSubalbum(), reorderSubalbumImages(), syncSubalbumList(), and ~Album().

QPixmap* Album::largeRepresentativeImage [private]

Definition at line 184 of file album.h. Referenced by Album(), getRepresentativeImage(), setRepresentativeImages(), and ~Album().

Subalbum* Album::lastSubalbum [private]

Pointer to last Subalbum. Definition at line 190 of file album.h. Referenced by Album(), appendSubalbum(), getLastSubalbum(), removeSubalbum(), and syncSubalbumList().

int Album::modificationDay [private]

Last modification day. Definition at line 199 of file album.h. Referenced by exportToXML(), getModificationDay(), and updateModificationDate().

int Album::modificationMonth [private]

Last modification month. Definition at line 196 of file album.h. Referenced by exportToXML(), getModificationMonth(), and updateModificationDate().

int Album::modificationYear [private]

Last modification year. Definition at line 193 of file album.h. Referenced by exportToXML(), getModificationYear(), and updateModificationDate().

bool Album::modified [private]

Modification status of the album. Definition at line 226 of file album.h. Referenced by Album(), albumModified(), appendSubalbum(), exportToDisk(), removeSubalbum(), setAuthor(), setDescription(), setModified(), setName(), and setRepresentativeImages().

QString Album::name [private]

Short name for album. Definition at line 174 of file album.h. Referenced by Album(), exportToXML(), getName(), importFromDisk(), and setName().

int Album::numLoadedSubalbums [private]

Number of loaded subalbums. Definition at line 214 of file album.h. Referenced by Album(), importFromDisk(), and removeStagnantImages().

int Album::numSubalbums [private]

Number of subalbums. Definition at line 211 of file album.h. Referenced by Album(), appendSubalbum(), exportToDisk(), getNumSubalbums(), importFromDisk(), removeStagnantImages(), and removeSubalbum().

bool Album::savedToDisk [private]

Set if album was loaded/has been saved to disk. Definition at line 217 of file album.h. Referenced by Album(), exportToDisk(), importFromDisk(), and prevSave().

QString Album::saveLocation [private]

Directory album saved to. Definition at line 220 of file album.h. Referenced by Album(), exportSubalbumImages(), exportThemeResources(), exportToDisk(), exportTopLevelImages(), exportToXML(), getSaveLocation(), importFromDisk(), removeStagnantImages(), and reorderSubalbumImages().

QPixmap* Album::smallRepresentativeImage [private]

Representative images. Definition at line 183 of file album.h. Referenced by Album(), getRepresentativeImage(), setRepresentativeImages(), and ~Album().

QString Album::theme [private]

Theme to save album with. Definition at line 223 of file album.h. Referenced by Album(), exportToDisk(), exportToXML(), getTheme(), and importFromDisk().

---

The documentation for this class was generated from the following files:

• album.h
• album.cpp

---