Subalbum Class Reference

#include <subalbum.h>

Collaboration diagram for Subalbum:

[legend]List of all members.

---

Detailed Description

A subalbum contains photos.

Specific contents:

• Photos
• Name
• Description
• Representative image
• Subalbum number
• Number of Photos

Definition at line 51 of file subalbum.h.

Public Member Functions
	Subalbum (Album *albm, int number)
	Sets default information is the Subalbum number.
	~Subalbum ()
	Frees photos.
void	setName (QString val)
	Sets the Subalbum Name.
QString	getName ()
	Gets the Subalbum Name.
void	setDescription (QString val)
	Sets the Subalbum description.
QString	getDescription ()
	Gets the Subalbum description.
QPixmap *	getRepresentativeImage (int size)
	gets a sized representative image
void	setRepresentativeImages (QImage *val)
	sets a sized representative iamge
bool	addPhoto (QString fileName, bool replaceDescription=false, Photo *newPhoto=NULL)
	Adds a new photo to the Subalbum and appends it to the end, returns TRUE if successful.
bool	lazyAddPhoto (QString imageName, QString slideshowName, QString thumbnailName, Photo *newPhoto)
	Lazily adds a new photo to the subalbum without rescaling from scrath, returns TRUE if successful.
void	addPhoto (Photo *newPhoto)
	Adds a preexisting photo object to the Subalbum, appending it to the end.
void	photoMoved (Photo *val)
	Removes a specified photo without deleting the object.
void	removePhoto (Photo *val)
	Removes a specified photo.
Subalbum *	getNext ()
	Returns pointer to next subalbum.
void	setNext (Subalbum *val)
	Sets pointer of next subalbum.
Photo *	getFirst ()
	Returns first photo in subalbum.
Photo *	getLast ()
	Returns last photo in subalbum.
void	exportToXML (QTextStream &stream)
	Exports subalbum to xml.
void	importFromDisk (QDomNode *root, int subalbumNum, StatusWidget *status, QString dirName)
	Builds subalbum from XML DOM node.
void	syncPhotoList (PhotoWidget *item)
	Syncs photo ordering with front end gui ordering.
int	getSubalbumNumber ()
	Returns subalbum number.
int	getNumPhotos ()
	Returns the number of photos in the subalbum.
int	getNumLoadedPhotos ()
	Returns the number of loaded photos in subalbum.
void	resetNumLoadedPhotos ()
void	setModified ()
Private Attributes
int	number
	Subalbum Number.
int	numPhotos
	Number of photos in subalbum.
int	loadedPhotos
	Number of photos in subalbum when last loaded.
QString	name
	Short Name for subalbum.
QString	description
	Longer description of subalbum.
QPixmap *	smallRepresentativeImage
QPixmap *	mediumRepresentativeImage
QPixmap *	largeRepresentativeImage
Photo *	firstPhoto
	Pointer to first photo.
Photo *	lastPhoto
	Pointer to last photo.
Subalbum *	nextSubalbum
	Pointer to next subalbum.
Album *	albm
	Pointer to album subalbum is in.

---

Constructor & Destructor Documentation

Subalbum::Subalbum (  Album *  albm, int  number )

Sets default information is the Subalbum number. Definition at line 41 of file subalbum.cpp. References description, firstPhoto, IMAGE_PATH, largeRepresentativeImage, lastPhoto, loadedPhotos, mediumRepresentativeImage, name, nextSubalbum, numPhotos, and smallRepresentativeImage. { //set subalbum number this->number = number; //by default no photos in subalbum numPhotos = 0; loadedPhotos = 0; //set strings to default values name = ""; description =""; //set default rep images smallRepresentativeImage = new QPixmap( QString(IMAGE_PATH)+"notSpecified.png" ); mediumRepresentativeImage = new QPixmap( QString(IMAGE_PATH)+"subalbum.png" ); largeRepresentativeImage = NULL; //no photos by default firstPhoto = NULL; lastPhoto = NULL; //next pointer null by default nextSubalbum = NULL; //set album pointer this->albm = albm; }

Subalbum::~Subalbum (   )

Frees photos. Definition at line 71 of file subalbum.cpp. References firstPhoto, Photo::getNext(), largeRepresentativeImage, mediumRepresentativeImage, and smallRepresentativeImage. { //delete representative images delete smallRepresentativeImage; delete mediumRepresentativeImage; delete largeRepresentativeImage; //delete all photos Photo* current = firstPhoto; Photo* temp; while(current != NULL) { temp = current->getNext(); delete current; current = temp; } }

---

Member Function Documentation

void Subalbum::addPhoto (  Photo *  newPhoto  )

Adds a preexisting photo object to the Subalbum, appending it to the end. Definition at line 203 of file subalbum.cpp. References albm, firstPhoto, lastPhoto, numPhotos, Album::setModified(), and Photo::setNext(). { //increase counter numPhotos++; //set it's next pointer to null newPhoto->setNext(NULL); //if this is the only photo, set first and last //pointers to this photo. if(firstPhoto == NULL) { firstPhoto = newPhoto; lastPhoto = newPhoto; } //else append to end of list else { lastPhoto->setNext(newPhoto); lastPhoto = newPhoto; } //set modified albm->setModified(); }

bool Subalbum::addPhoto (  QString  fileName, bool  replaceDescription = false, Photo *  newPhoto = NULL )

Adds a new photo to the Subalbum and appends it to the end, returns TRUE if successful. Definition at line 230 of file subalbum.cpp. References albm, Photo::deallocateLargeImages(), firstPhoto, Photo::getImage(), IMAGE, lastPhoto, number, numPhotos, Photo::setDescription(), Photo::setImage(), Photo::setImageFilename(), Album::setModified(), Photo::setNext(), Photo::setSlideshowFilename(), and SLIDESHOW. Referenced by SubalbumWidget::addImageAction(), SubalbumPreviewWidget::dropped(), and importFromDisk(). { numPhotos++; //create new photo if necessary if(newPhoto == NULL) newPhoto = new Photo(this, numPhotos); //replace description with filename if instructed //(aka /home/bob/happy.jpg -> happy) if(replaceDescription) { QString desc(fileName); desc = desc.section( QRegExp("/"), -1); desc.truncate(desc.length() - 4); newPhoto->setDescription( desc ); } //attempt to set image if(!newPhoto->setImage(fileName)) { delete newPhoto; return false; } //if this is the only photo, set first and last //pointers to this photo. if(firstPhoto == NULL) { firstPhoto = newPhoto; lastPhoto = newPhoto; } //else append to end of list else { lastPhoto->setNext(newPhoto); lastPhoto = newPhoto; } //copy image file over QString saveName = QDir::homeDirPath() + QString("/.albumShaper/tmp/%1_%2") .arg(number) .arg(numPhotos); newPhoto->getImage(IMAGE)->save( saveName + ".jpg", "JPEG", 100); newPhoto->getImage(SLIDESHOW)->save( saveName + "_slideshow.jpg", "JPEG", 100); newPhoto->setImageFilename(saveName + ".jpg"); newPhoto->setSlideshowFilename(saveName + "_slideshow.jpg"); //deallocate full image and slideshow versions to conserve memory newPhoto->deallocateLargeImages(); //set modified albm->setModified(); return true; }

void Subalbum::exportToXML (  QTextStream &  stream  )

Exports subalbum to xml. Definition at line 370 of file subalbum.cpp. References description, Photo::exportToXML(), firstPhoto, fixXMLString(), Photo::getNext(), getRepresentativeImage(), LARGE, name, and number. Referenced by Album::exportToXML(). { //write subalbum information stream << " <subalbum>\n"; stream << " <name>" << fixXMLString(name) << "</name>\n"; stream << " <description>" << fixXMLString(description) << "</description>\n"; //if subalbum has a represenatative image save it's path if(getRepresentativeImage(LARGE) != NULL ) { stream << " <thumb path=\"img/" << number << "_thumb.jpg\"/>\n"; } //write photos Photo* current = firstPhoto; while(current != NULL) { current->exportToXML(stream); current = current->getNext(); } //close subalbum stream << " </subalbum>\n"; }

QString Subalbum::getDescription (   )

Gets the Subalbum description. Definition at line 116 of file subalbum.cpp. References description. Referenced by SubalbumWidget::setSubalbum(), and SubalbumWidget::SubalbumWidget(). { return QString(description); }

Photo * Subalbum::getFirst (   )

Returns first photo in subalbum. Definition at line 396 of file subalbum.cpp. References firstPhoto. Referenced by AlbumStatistics::AlbumStatistics(), Album::exportSubalbumImages(), SubalbumWidget::refreshPhotos(), and Album::reorderSubalbumImages(). { return firstPhoto; }

Photo * Subalbum::getLast (   )

Returns last photo in subalbum. Definition at line 401 of file subalbum.cpp. References lastPhoto. Referenced by SubalbumWidget::addImageAction(). { return lastPhoto; }

QString Subalbum::getName (   )

Gets the Subalbum Name. Definition at line 100 of file subalbum.cpp. References name. Referenced by SubalbumWidget::setSubalbum(), and SubalbumWidget::SubalbumWidget(). { return QString(name); }

Subalbum * Subalbum::getNext (   )

Returns pointer to next subalbum. Definition at line 357 of file subalbum.cpp. References nextSubalbum. Referenced by AlbumStatistics::AlbumStatistics(), Album::exportSubalbumImages(), Album::exportToDisk(), Album::exportTopLevelImages(), Album::exportToXML(), SubalbumsWidget::refresh(), Album::removeStagnantImages(), Album::removeSubalbum(), Album::reorderSubalbumImages(), and Album::~Album(). { return nextSubalbum; }

int Subalbum::getNumLoadedPhotos (   )

Returns the number of loaded photos in subalbum. Definition at line 595 of file subalbum.cpp. References loadedPhotos. Referenced by Album::removeStagnantImages(). { return loadedPhotos;; }

int Subalbum::getNumPhotos (   )

Returns the number of photos in the subalbum. Definition at line 590 of file subalbum.cpp. References numPhotos. Referenced by AlbumStatistics::AlbumStatistics(), Album::exportToDisk(), and Album::removeStagnantImages(). { return numPhotos;; }

QPixmap * Subalbum::getRepresentativeImage (  int  size  )

gets a sized representative image Definition at line 122 of file subalbum.cpp. References LARGE, largeRepresentativeImage, MEDIUM, mediumRepresentativeImage, SMALL, and smallRepresentativeImage. Referenced by Album::exportTopLevelImages(), exportToXML(), SubalbumWidget::setImageAction(), SubalbumWidget::setSubalbum(), and SubalbumWidget::SubalbumWidget(). { if(size == SMALL) return smallRepresentativeImage; if(size == MEDIUM) return mediumRepresentativeImage; if(size == LARGE) return largeRepresentativeImage; else return NULL; }

int Subalbum::getSubalbumNumber (   )

Returns subalbum number. Definition at line 585 of file subalbum.cpp. References number. { return number; }

void Subalbum::importFromDisk (  QDomNode *  root, int  subalbumNum, StatusWidget *  status, QString  dirName )

Builds subalbum from XML DOM node. Definition at line 406 of file subalbum.cpp. References addPhoto(), description, Photo::getImageChecksum(), getMD5(), Photo::getSlideshowChecksum(), Photo::getThumbnailChecksum(), Photo::importFromDisk(), StatusWidget::incrementProgress(), lazyAddPhoto(), name, resetNumLoadedPhotos(), and setRepresentativeImages(). Referenced by Album::importFromDisk(). { //if representative image exists load QString repName = QString(dirName + "/img/%1_thumb.jpg").arg(subalbumNum); QImage repImage(repName); if(!repImage.isNull()) { setRepresentativeImages(&repImage); } QDomNode node = root->firstChild(); QDomText val; int photoNum = 0; while( !node.isNull() ) { //------------------------------------------------------------ //subalbum name if( node.isElement() && node.nodeName() == "name" ) { val = node.firstChild().toText(); if(!val.isNull()) name = val.nodeValue(); } //------------------------------------------------------------ //subalbum description else if( node.isElement() && node.nodeName() == "description" ) { val = node.firstChild().toText(); if(!val.isNull()) description = val.nodeValue(); } //------------------------------------------------------------ //photo else if( node.isElement() && node.nodeName() == "photo" ) { //increase counter photoNum++; //create new photo object QString imageName = QString(dirName + "img/%1/%2.jpg").arg(subalbumNum).arg(photoNum); QString slideshowName = QString(dirName + "img/%1/%2_slideshow.jpg").arg(subalbumNum).arg(photoNum); QString thumbName = QString(dirName + "img/%1/%2_thumb.jpg").arg(subalbumNum).arg(photoNum); Photo* newPhoto = new Photo(this, photoNum); //load photo information from disk QDateTime* modificationTimes = newPhoto->importFromDisk( &node ); //first check to see if modifications times have changed bool lazyLoad = true; //assume no modifications QFileInfo info[3]; info[0].setFile( imageName ); info[1].setFile( slideshowName ); info[2].setFile( thumbName ); if(modificationTimes[0] != info[0].lastModified() || modificationTimes[1] != info[1].lastModified() || modificationTimes[2] != info[2].lastModified()) lazyLoad = false; //if no changes have occured do lazy load - don't //bother scaling down thumbnail and slideshow images //from original image std::ifstream imageFile( imageName ); std::ifstream slideshowFile( slideshowName ); std::ifstream thumbnailFile( thumbName ); if( lazyLoad || ( imageFile.is_open() && thumbnailFile.is_open() && slideshowFile.is_open() && getMD5(imageFile) == newPhoto->getImageChecksum() && getMD5(slideshowFile) == newPhoto->getSlideshowChecksum() && getMD5(thumbnailFile) == newPhoto->getThumbnailChecksum() ) ) { //close ifstreams imageFile.close(); slideshowFile.close(); thumbnailFile.close(); //populate image lazyAddPhoto(imageName, slideshowName, thumbName, newPhoto); } //else reload image and scale it since changes have occured. else { //close ifstreams if open if(imageFile.is_open()) imageFile.close(); if(thumbnailFile.is_open()) thumbnailFile.close(); //populate image addPhoto(imageName, false, newPhoto); } if(imageFile.is_open()) imageFile.close(); if(slideshowFile.is_open()) slideshowFile.close(); if(thumbnailFile.is_open()) thumbnailFile.close(); //update progress bar status->incrementProgress(); qApp->processEvents(); } //------------------------------------------------------------ //advance to next node node = node.nextSibling(); //------------------------------------------------------------ } //------------------------------------------------------------ //set loaded number resetNumLoadedPhotos(); //------------------------------------------------------------ }

bool Subalbum::lazyAddPhoto (  QString  imageName, QString  slideshowName, QString  thumbnailName, Photo *  newPhoto )

Lazily adds a new photo to the subalbum without rescaling from scrath, returns TRUE if successful. Definition at line 289 of file subalbum.cpp. References albm, firstPhoto, lastPhoto, numPhotos, Photo::setImage(), Album::setModified(), and Photo::setNext(). Referenced by importFromDisk(). { numPhotos++; //attempt to set image if(!newPhoto->setImage(imageName, slideshowName, thumbnailName)) { delete newPhoto; return false; } //if this is the only photo, set first and last //pointers to this photo. if(firstPhoto == NULL) { firstPhoto = newPhoto; lastPhoto = newPhoto; } //else append to end of list else { lastPhoto->setNext(newPhoto); lastPhoto = newPhoto; } //set modified albm->setModified(); return true; }

void Subalbum::photoMoved (  Photo *  val  )

Removes a specified photo without deleting the object. Definition at line 528 of file subalbum.cpp. References albm, firstPhoto, Photo::getNext(), lastPhoto, numPhotos, Album::setModified(), and Photo::setNext(). Referenced by SubalbumPreviewWidget::dropped(). { //decrease counter numPhotos--; //walk through list of photos and find specified photo Photo* current = firstPhoto; Photo* prev = NULL; while(current != NULL && current != val) { prev = current; current = current->getNext(); } if(current == val) { //update prev next pointer if(prev != NULL) prev->setNext(current->getNext()); //update first and last pointers if necessary if(current == firstPhoto) firstPhoto = current->getNext(); if(current == lastPhoto) lastPhoto = prev; } //set modified albm->setModified(); }

void Subalbum::removePhoto (  Photo *  val  )

Removes a specified photo. Definition at line 324 of file subalbum.cpp. References albm, firstPhoto, Photo::getNext(), lastPhoto, numPhotos, Album::setModified(), and Photo::setNext(). Referenced by SubalbumWidget::removeImageAction(). { //walk through list of photos and find specified photo Photo* current = firstPhoto; Photo* prev = NULL; while(current != val && current->getNext() != NULL) { prev = current; current = current->getNext(); } if(current == val) { //update prev next pointer if(prev != NULL) prev->setNext(current->getNext()); //update first and last pointers if necessary if(current == firstPhoto) firstPhoto = current->getNext(); if(current == lastPhoto) lastPhoto = prev; //free Photo delete current; current = NULL; numPhotos--; } //set modified albm->setModified(); }

void Subalbum::resetNumLoadedPhotos (   )

Definition at line 600 of file subalbum.cpp. References loadedPhotos, and numPhotos. Referenced by importFromDisk(), and Album::removeStagnantImages(). { loadedPhotos = numPhotos; }

void Subalbum::setDescription (  QString  val  )

Sets the Subalbum description. Definition at line 106 of file subalbum.cpp. References albm, description, and Album::setModified(). Referenced by SubalbumWidget::updateDescription(). { if(description != val) { description = val; albm->setModified(); } }

void Subalbum::setModified (   )

Definition at line 605 of file subalbum.cpp. References albm, and Album::setModified(). Referenced by Photo::flipHorizontally(), Photo::flipVertically(), Photo::rotate270(), Photo::rotate90(), Photo::setDescription(), Photo::setImage(), and Photo::setNext(). { albm->setModified(); }

void Subalbum::setName (  QString  val  )

Sets the Subalbum Name. Definition at line 90 of file subalbum.cpp. References albm, name, and Album::setModified(). Referenced by SubalbumWidget::updateName(). { if(name != val) { name = val; albm->setModified(); } }

void Subalbum::setNext (  Subalbum *  val  )

Sets pointer of next subalbum. Definition at line 362 of file subalbum.cpp. References albm, nextSubalbum, and Album::setModified(). Referenced by Album::appendSubalbum(), Album::removeSubalbum(), and Album::syncSubalbumList(). { nextSubalbum = val; //set modified albm->setModified(); }

void Subalbum::setRepresentativeImages (  QImage *  val  )

sets a sized representative iamge Definition at line 135 of file subalbum.cpp. References albm, largeRepresentativeImage, mediumRepresentativeImage, resizeImage(), Album::setModified(), and smallRepresentativeImage. Referenced by importFromDisk(), and SubalbumWidget::setImageAction(). { //--------------------------------------------------------- //delete old representative images delete smallRepresentativeImage; delete mediumRepresentativeImage; delete largeRepresentativeImage; //--------------------------------------------------------- //compute various representative image sizes int smallRepWidth = 0; int smallRepHeight = 0; int mediumRepWidth = 0; int mediumRepHeight = 0; resizeImage( rawThumbnail->width(), rawThumbnail->height(), 131, 98, mediumRepWidth, mediumRepHeight); resizeImage( rawThumbnail->width(), rawThumbnail->height(), 107, 80, smallRepWidth, smallRepHeight); //--------------------------------------------------------- //create various representative images //--------------------------------------------------------- //copy and scale small version QImage thumbnailSmall = rawThumbnail->smoothScale( smallRepWidth, smallRepHeight ); smallRepresentativeImage = new QPixmap( smallRepWidth, smallRepHeight ); smallRepresentativeImage->convertFromImage( thumbnailSmall ); //copy and scale medium version QImage thumbnailMedium = rawThumbnail->smoothScale( mediumRepWidth, mediumRepHeight ); QImage* centeredThumbnailMedium = new QImage(131, 98, thumbnailMedium.depth()); centeredThumbnailMedium->setAlphaBuffer(true); int xDiff = 131 - mediumRepWidth; int yDiff = 98 - mediumRepHeight; //set all pixels to white int x, y; for(x=0; x< 131; x++) { for(y=0; y<98; y++) { centeredThumbnailMedium->setPixel(x, y, QColor(255, 255, 255).rgb()); } } int x2 = 0; for(x= xDiff/2; x < (xDiff/2) + mediumRepWidth; x++) { int y2 = 0; for(y= yDiff/2; y < (yDiff/2) + mediumRepHeight; y++) { centeredThumbnailMedium->setPixel(x, y, thumbnailMedium.pixel(x2, y2)); y2++; } x2++; } mediumRepresentativeImage = new QPixmap( centeredThumbnailMedium->width(), centeredThumbnailMedium->height() ); mediumRepresentativeImage->convertFromImage( *centeredThumbnailMedium ); delete centeredThumbnailMedium; //copy large version largeRepresentativeImage = new QPixmap(*rawThumbnail); //--------------------------------------------------------- //set modified albm->setModified(); }

void Subalbum::syncPhotoList (  PhotoWidget *  item  )

Syncs photo ordering with front end gui ordering. Definition at line 560 of file subalbum.cpp. References firstPhoto, PhotoWidget::getPhoto(), lastPhoto, and Photo::setNext(). Referenced by SubalbumWidget::reorder(). { //base case, no items if(item == NULL) { firstPhoto = NULL; lastPhoto = NULL; return; } //set first and last pointers firstPhoto = item->getPhoto(); firstPhoto->setNext(NULL); lastPhoto = firstPhoto; //set all next pointers while(item->nextItem() != NULL) { item->getPhoto()->setNext( ((PhotoWidget*)item->nextItem())->getPhoto() ); item = (PhotoWidget*)item->nextItem(); lastPhoto = item->getPhoto(); lastPhoto->setNext(NULL); } }

---

Member Data Documentation

Album* Subalbum::albm [private]

Pointer to album subalbum is in. Definition at line 167 of file subalbum.h. Referenced by addPhoto(), lazyAddPhoto(), photoMoved(), removePhoto(), setDescription(), setModified(), setName(), setNext(), and setRepresentativeImages().

QString Subalbum::description [private]

Longer description of subalbum. Definition at line 150 of file subalbum.h. Referenced by exportToXML(), getDescription(), importFromDisk(), setDescription(), and Subalbum().

Photo* Subalbum::firstPhoto [private]

Pointer to first photo. Definition at line 158 of file subalbum.h. Referenced by addPhoto(), exportToXML(), getFirst(), lazyAddPhoto(), photoMoved(), removePhoto(), Subalbum(), syncPhotoList(), and ~Subalbum().

QPixmap* Subalbum::largeRepresentativeImage [private]

Definition at line 155 of file subalbum.h. Referenced by getRepresentativeImage(), setRepresentativeImages(), Subalbum(), and ~Subalbum().

Photo* Subalbum::lastPhoto [private]

Pointer to last photo. Definition at line 161 of file subalbum.h. Referenced by addPhoto(), getLast(), lazyAddPhoto(), photoMoved(), removePhoto(), Subalbum(), and syncPhotoList().

int Subalbum::loadedPhotos [private]

Number of photos in subalbum when last loaded. Definition at line 144 of file subalbum.h. Referenced by getNumLoadedPhotos(), resetNumLoadedPhotos(), and Subalbum().

QPixmap* Subalbum::mediumRepresentativeImage [private]

Definition at line 154 of file subalbum.h. Referenced by getRepresentativeImage(), setRepresentativeImages(), Subalbum(), and ~Subalbum().

QString Subalbum::name [private]

Short Name for subalbum. Definition at line 147 of file subalbum.h. Referenced by exportToXML(), getName(), importFromDisk(), setName(), and Subalbum().

Subalbum* Subalbum::nextSubalbum [private]

Pointer to next subalbum. Definition at line 164 of file subalbum.h. Referenced by getNext(), setNext(), and Subalbum().

int Subalbum::number [private]

Subalbum Number. Definition at line 138 of file subalbum.h. Referenced by addPhoto(), exportToXML(), and getSubalbumNumber().

int Subalbum::numPhotos [private]

Number of photos in subalbum. Definition at line 141 of file subalbum.h. Referenced by addPhoto(), getNumPhotos(), lazyAddPhoto(), photoMoved(), removePhoto(), resetNumLoadedPhotos(), and Subalbum().

QPixmap* Subalbum::smallRepresentativeImage [private]

Definition at line 153 of file subalbum.h. Referenced by getRepresentativeImage(), setRepresentativeImages(), Subalbum(), and ~Subalbum().

---

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

• subalbum.h
• subalbum.cpp

---