Photo Class Reference

A photo consists of a full size image, a smaller slide show image, a very small thumbnail image, and a desription. More...

#include <photo.h>

Collaboration diagram for Photo:

Public Member Functions
	Photo (Subalbum *subalbum, Photo *prev, int photoNumber)
	Sets default information.
	~Photo ()
QImage *	getThumbnailImage ()
	Gets thumbnail image.
bool	constructSmallerImages ()
	Construct thumbnail and slideshow images, load up thumbnail image, and set photo has being modified.
bool	setImage (QString imageName, QString slideshowName, QString thumbnailName)
	Setup photo using preexisting full size, slideshow, and thumbnail images.
bool	setImage (QString imageName, int uniqueID)
	Setup photo using a new image. We'll need to create slideshow and thumbnail images.
bool	setImage (QString editedImageFilename)
	Reset photo data after photo editing has taken place.
QString	getImageFilename ()
	Gets the image filename.
QString	getSlideshowFilename ()
	Gets the slideshow filename.
QString	getThumbnailFilename ()
	Gets the thumbnail filename.
void	setImageFilename (QString val)
	Sets the image filename.
void	setSlideshowFilename (QString val)
	Sets the slideshow filename.
void	setThumbnailFilename (QString val)
	Sets the thumbnail filename.
QString	getImageChecksum ()
	Get image checksum.
QString	getThumbnailChecksum ()
	Get thumbanil checksum.
QString	getSlideshowChecksum ()
	Get thumbanil checksum.
void	setImageChecksum (QString val)
	Update image checksum.
void	setThumbnailChecksum (QString val)
	Update thumbnail checksum.
void	setSlideshowChecksum (QString val)
	Update slideshow checksum.
QString	getDescription ()
	Gets the description.
void	setDescription (QString val)
	Sets the description.
Photo *	getPrev ()
	Returns the previous photo pointer.
Photo *	getNext ()
	Returns next photo pointer.
void	setPrev (Photo *val)
	Sets prev photo pointer.
void	setNext (Photo *val)
	Sets next photo pointer.
QDateTime *	importFromDisk (QDomNode *root)
	Builds photo from XML DOM node, returns date modified info from xml.
void	exportToXML (Q3TextStream &stream)
	Exports photo to xml.
void	rotate90 ()
	Rotates image clockwise 90 degrees.
void	rotate270 ()
	Rotates image clockwise 270 degrees.
void	flipHorizontally ()
	Flips image about horizontal axis.
void	flipVertically ()
	Flips image about vertical axis.
void	applyTransformation (TRANSFORM_CODE transformation)
	Apply transformation.
bool	getNeedsSavingVal ()
	Returns if the image needs to be saved to its permament location.
void	setNeedsSavingVal (bool val)
	Sets if the image needs to be saved to its permanent location.
bool	getEverSaved ()
	Returns if the image has ever been saved to a permanant location.
void	setEverSaved (bool val)
	sets everSaved
void	revertPhoto ()
	revert photo to original form
bool	revertPossible ()
	can photo be reverted to a differnt original form
bool	getRecentlyReverted ()
	was the photo recently reverted? if so ignore the presence of orig files on disk
void	setRecentlyReverted (bool val)
	reset the recently reverted value to val
QString	originalImageFilename ()
	orig filename
int	getInitialPhotoNumber ()
	Returns initial photo number.
void	setInitialPhotoNumber (int val)
	Sets initial photo number.
int	getInitialSubalbumNumber ()
	Returns initial subalbum number.
void	setInitialSubalbumNumber (int val)
	Sets initial subalbum number.

Private Attributes
Subalbum *	subalbum
	Subalbum photo is in.
Photo *	prev
	Pointer to prev photo.
Photo *	next
	Pointer to next photo.
int	initialPhotoNumber
int	initialSubalbumNumber
QString	description
	Photo description.
QImage *	thumbnailImage
	Thumbnail Image.
QString	imageLocation
	Filenames
QString	slideshowLocation
QString	thumbnailLocation
QString	imageChecksum
	MD5 checksums, used to determine if image/thumbnail have been changed.
QString	slideshowChecksum
QString	thumbnailChecksum
bool	needsSaving
	Unsaved modifications?
bool	everSaved
	Has the photo ever been saved?
bool	recentlyReverted
	Has the photo recently been reverted to it's original form? If so during the next save the orig file can safely be remove.

Detailed Description

A photo consists of a full size image, a smaller slide show image, a very small thumbnail image, and a desription.

Definition at line 44 of file photo.h.

Constructor & Destructor Documentation

Photo()

Photo::Photo	(	Subalbum *	subalbum,
		Photo *	prev,
		int	photoNumber )

Sets default information.

Definition at line 32 of file photo.cpp.

{
  //set subalbum pointer
  this->subalbum = subalbum;
 
  //set prev pointer
  this->prev = prev;
  
  //set next pointer to NULL, new photos are always
  //inserted at the end of collections
  next = NULL;
  
  //set initial photo and subalbum numbers
  initialPhotoNumber = photoNumber;
  initialSubalbumNumber = subalbum->getSubalbumNumber();
 
  //set default to the empty string
  description = QString::null;
 
  //set thumbnail image
  thumbnailImage = NULL;
 
  //set filenames and checksums to null until the actual photo data has been set
  imageLocation     = QString::null;
  imageChecksum     = QString::null;
  
  slideshowLocation = QString::null;
  slideshowChecksum = QString::null;
  
  thumbnailLocation = QString::null;
  thumbnailChecksum = QString::null;
 
  //a default photo is not interesting. once the 
  //actual photo data or description files have
  //been reset the photo will need to be saved.
  needsSaving = false;
  
  //by default a photos are assumed to be saved. 
  //new photos are setup with a uniqueID and we'll set this bool false there
  everSaved = true;
  
  //photo not recently reverted
  recentlyReverted = false;
}

References description, everSaved, Subalbum::getSubalbumNumber(), imageChecksum, imageLocation, initialPhotoNumber, initialSubalbumNumber, needsSaving, next, prev, recentlyReverted, slideshowChecksum, slideshowLocation, subalbum, thumbnailChecksum, thumbnailImage, and thumbnailLocation.

~Photo()

Photo::~Photo

(

)

Definition at line 77 of file photo.cpp.

{
  //free the thumbnail image
  delete thumbnailImage;
}

References thumbnailImage.

Member Function Documentation

applyTransformation()

void Photo::applyTransformation

(

TRANSFORM_CODE

transformation

)

Apply transformation.

Definition at line 476 of file photo.cpp.

{  
  //backup old filename
  QString oldName = imageLocation;
   
  //if the image did not previously need saving, 
  //reset filenames to point to temporary location and
  //immediately perform transformation
  if(!needsSaving)
  {
    imageLocation = subalbum->getAlbum()->getTmpDir() + QString("/%1_%2.jpg")
                                                                .arg(initialSubalbumNumber)
                                                                .arg(initialPhotoNumber);
    slideshowLocation = subalbum->getAlbum()->getTmpDir() + QString("/%1_%2_slideshow.jpg")
                                                                .arg(initialSubalbumNumber)
                                                                .arg(initialPhotoNumber);
    thumbnailLocation = subalbum->getAlbum()->getTmpDir() + QString("/%1_%2_thumb.jpg")
                                                                .arg(initialSubalbumNumber)
                                                                .arg(initialPhotoNumber);
    transformImage( oldName, imageLocation, transformation );
  }
  else
  {
    //images that need saving already exist in the temporary directory
    //this poses two problems:
    //1.) fast jpeg transformations cannot be done in place, so we'll employ an
    //    intermediate image
    QString intermediateName = QString("%1_intermdiate.jpg").arg(oldName);
    transformImage( oldName, intermediateName, transformation );    
    
    //2.) If the photo has never been saved and an orig file in the temporary
    //    directory does not exist then the current file is the original version. we
    //    must make sure that this original photo is maintained using an orig file so
    //    in the future users can revert the photo to it's original form.
    QString origName = subalbum->getAlbum()->getTmpDir() + QString("/0_%1_orig.jpg")
      .arg(initialPhotoNumber);      
    QDir tmpDir;
    if( !getEverSaved() && !tmpDir.exists(origName) )
    {
      moveFile( oldName, origName );
      moveFile( intermediateName, imageLocation );
    }
    else
    {
      moveFile( intermediateName, imageLocation );
    }
  }
  
  //image now modified from original form so orig file needs to be kept
  recentlyReverted = false;
  
  //construct smaller iamges
  constructSmallerImages();
}

References constructSmallerImages(), Subalbum::getAlbum(), getEverSaved(), Album::getTmpDir(), imageLocation, initialPhotoNumber, initialSubalbumNumber, moveFile(), needsSaving, recentlyReverted, slideshowLocation, subalbum, thumbnailLocation, and transformImage().

Referenced by flipHorizontally(), flipVertically(), rotate270(), and rotate90().

constructSmallerImages()

bool Photo::constructSmallerImages

(

)

Construct thumbnail and slideshow images, load up thumbnail image, and set photo has being modified.

Definition at line 85 of file photo.cpp.

{
  //construct and save slideshow and thumbnail images
  QImage TslideshowImage, TthumbnailImage;
  constructImages( imageLocation, TslideshowImage, TthumbnailImage );  
  TslideshowImage.save( slideshowLocation, "JPEG", 95 );
  TthumbnailImage.save( thumbnailLocation, "JPEG", 95 );
 
  //load up thumbnail image
  delete thumbnailImage;
  thumbnailImage = new QImage(thumbnailLocation);
 
  //image is being stored in temp location, needs saving!
  needsSaving = true;
 
  //set the subalbum as being modified and return
  subalbum->setModified();
  return true;
}

References constructImages(), imageLocation, needsSaving, Subalbum::setModified(), slideshowLocation, subalbum, thumbnailImage, and thumbnailLocation.

Referenced by applyTransformation(), setImage(), and setImage().

exportToXML()

void Photo::exportToXML

(

Q3TextStream &

stream

)

Exports photo to xml.

Definition at line 414 of file photo.cpp.

{
  QFileInfo info;
 
  //write photo information
  stream << "    <photo>\n";
  //-----
  stream << "      <description>" << fixXMLString(description) << "</description>\n";
  //-----
  //full image
  info.setFile( getImageFilename() );
  QDateTime modified = info.lastModified();
  stream << "      <image>\n";
  stream << "        <md5>" << fixXMLString(imageChecksum) << "</md5>\n";
  stream << "        <modified>";
  stream << modified.date().year() << " ";
  stream << modified.date().month() << " ";
  stream << modified.date().day() << " ";
  stream << modified.time().hour() << " ";
  stream << modified.time().minute() << " ";
  stream << modified.time().second() << " ";
  stream << modified.time().msec() << "</modified>\n";
  stream << "      </image>\n";
  //-----
  //slidehow image
  info.setFile( getSlideshowFilename() );
  modified = info.lastModified();
  stream << "      <slideshow>\n";
  stream << "        <md5>" << fixXMLString(slideshowChecksum) << "</md5>\n";
  stream << "        <modified>";
  stream << modified.date().year() << " ";
  stream << modified.date().month() << " ";
  stream << modified.date().day() << " ";
  stream << modified.time().hour() << " ";
  stream << modified.time().minute() << " ";
  stream << modified.time().second() << " ";
  stream << modified.time().msec() << "</modified>\n";
  stream << "      </slideshow>\n";
  //-----
  //thumbnail image
  info.setFile( getThumbnailFilename() );
  modified = info.lastModified();
  stream << "      <thumb>\n";
  stream << "        <md5>" << fixXMLString(thumbnailChecksum) << "</md5>\n";
  stream << "        <modified>";
  stream << modified.date().year() << " ";
  stream << modified.date().month() << " ";
  stream << modified.date().day() << " ";
  stream << modified.time().hour() << " ";
  stream << modified.time().minute() << " ";
  stream << modified.time().second() << " ";
  stream << modified.time().msec() << "</modified>\n";
  stream << "      </thumb>\n";
  //-----
  stream << "    </photo>\n";
}

References description, fixXMLString(), getImageFilename(), getSlideshowFilename(), getThumbnailFilename(), imageChecksum, slideshowChecksum, and thumbnailChecksum.

Referenced by Subalbum::exportToXML().

flipHorizontally()

void Photo::flipHorizontally

(

)

Flips image about horizontal axis.

Definition at line 473 of file photo.cpp.

{ applyTransformation( FLIP_H );     }

References applyTransformation(), and FLIP_H.

flipVertically()

void Photo::flipVertically

(

)

Flips image about vertical axis.

Definition at line 474 of file photo.cpp.

{ applyTransformation( FLIP_V );     }

References applyTransformation(), and FLIP_V.

getDescription()

QString Photo::getDescription

(

)

Gets the description.

Definition at line 208 of file photo.cpp.

{ return QString(description); }

References description.

Referenced by PhotoDescEdit::PhotoDescEdit(), PhotoPreviewWidget::PhotoPreviewWidget(), SlideshowWidget::showPhoto(), and PhotoPreviewWidget::updateDescription().

getEverSaved()

bool Photo::getEverSaved

(

)

Returns if the image has ever been saved to a permanant location.

Definition at line 534 of file photo.cpp.

{ return everSaved; }

References everSaved.

Referenced by applyTransformation(), Album::exportSubalbumImages(), originalImageFilename(), and setImage().

getImageChecksum()

QString Photo::getImageChecksum

(

)

Get image checksum.

Definition at line 200 of file photo.cpp.

{ return imageChecksum; }

References imageChecksum.

Referenced by Subalbum::importFromDisk().

getImageFilename()

QString Photo::getImageFilename

(

)

Gets the image filename.

Definition at line 192 of file photo.cpp.

{ return imageLocation;     }

References imageLocation.

Referenced by EditingInterface::adjustGrain(), AlbumStatistics::AlbumStatistics(), EditingInterface::applyEffect(), EditingInterface::applyImageUpdate(), EditingInterface::colorBalance(), EditingInterface::crop(), EditingInterface::enhanceContrast(), Album::exportLargeImages(), Album::exportSubalbumImages(), exportToXML(), EditingInterface::finishCorrectTilt(), SlideshowWidget::loadPhoto(), PhotoDescEdit::PhotoDescEdit(), EditingInterface::removeRedeye(), Album::removeStagnantOrigFiles(), EditingInterface::revertCurrentPhoto(), revertPossible(), EditingInterface::rotateFlip(), TitleWidget::setAlbumImage(), EditingInterface::setPhoto(), setWallpaper(), EditingInterface::showNextPrevFirstLastPhoto(), and EditingInterface::tuneLevels().

getInitialPhotoNumber()

int Photo::getInitialPhotoNumber

(

)

Returns initial photo number.

Definition at line 608 of file photo.cpp.

{ return initialPhotoNumber; }

References initialPhotoNumber.

Referenced by Album::exportSubalbumImages(), and Album::reorderSubalbumImages().

getInitialSubalbumNumber()

int Photo::getInitialSubalbumNumber

(

)

Returns initial subalbum number.

Definition at line 611 of file photo.cpp.

{ return initialSubalbumNumber; }

References initialSubalbumNumber.

Referenced by Album::exportSubalbumImages(), and Album::reorderSubalbumImages().

getNeedsSavingVal()

bool Photo::getNeedsSavingVal

(

)

Returns if the image needs to be saved to its permament location.

Definition at line 531 of file photo.cpp.

{ return needsSaving; }

References needsSaving.

Referenced by Album::exportSubalbumImages().

getNext()

Photo * Photo::getNext

(

)

Returns next photo pointer.

Definition at line 225 of file photo.cpp.

{ return next; }

References next.

Referenced by SlideshowWidget::advancePhoto(), AlbumStatistics::AlbumStatistics(), SlideshowWidget::beginSlideshow(), Album::exportCompressedWebAlbum(), Album::exportLargeImages(), Album::exportSubalbumImages(), Subalbum::exportToXML(), Album::getThumbnailFilenames(), Subalbum::photoMoved(), SubalbumWidget::refreshPhotos(), Subalbum::removePhoto(), Album::removeStagnantOrigFiles(), Album::reorderSubalbumImages(), EditingInterface::setPhoto(), EditingInterface::showNextPhoto(), EditingInterface::showNextPrevFirstLastPhoto(), Subalbum::syncPhotoList(), and Subalbum::~Subalbum().

getPrev()

Photo * Photo::getPrev

(

)

Returns the previous photo pointer.

Definition at line 224 of file photo.cpp.

{ return prev; }

References prev.

Referenced by SlideshowWidget::backupPhoto(), Subalbum::photoMoved(), Subalbum::removePhoto(), EditingInterface::setPhoto(), EditingInterface::showNextPrevFirstLastPhoto(), and EditingInterface::showPrevPhoto().

getRecentlyReverted()

bool Photo::getRecentlyReverted

(

)

was the photo recently reverted? if so ignore the presence of orig files on disk

Definition at line 547 of file photo.cpp.

{
  return recentlyReverted;
}

References recentlyReverted.

Referenced by Album::exportSubalbumImages(), and Album::removeStagnantOrigFiles().

getSlideshowChecksum()

QString Photo::getSlideshowChecksum

(

)

Get thumbanil checksum.

Definition at line 202 of file photo.cpp.

{ return slideshowChecksum; }

References slideshowChecksum.

Referenced by Subalbum::importFromDisk().

getSlideshowFilename()

QString Photo::getSlideshowFilename

(

)

Gets the slideshow filename.

Definition at line 193 of file photo.cpp.

{ return slideshowLocation; }

References slideshowLocation.

Referenced by AlbumStatistics::AlbumStatistics(), Album::exportCompressedWebAlbum(), Album::exportSubalbumImages(), exportToXML(), and PhotoDescEdit::PhotoDescEdit().

getThumbnailChecksum()

QString Photo::getThumbnailChecksum

(

)

Get thumbanil checksum.

Definition at line 201 of file photo.cpp.

{ return thumbnailChecksum; }

References thumbnailChecksum.

Referenced by Subalbum::importFromDisk().

getThumbnailFilename()

QString Photo::getThumbnailFilename

(

)

Gets the thumbnail filename.

Definition at line 194 of file photo.cpp.

{ return thumbnailLocation; }

References thumbnailLocation.

Referenced by Album::exportCompressedWebAlbum(), Album::exportSubalbumImages(), exportToXML(), Album::getThumbnailFilenames(), PhotoDescEdit::PhotoDescEdit(), TitleWidget::setSubalbumImage(), and PhotoPreviewWidget::updateImage().

getThumbnailImage()

QImage * Photo::getThumbnailImage

(

)

Gets thumbnail image.

Definition at line 83 of file photo.cpp.

{ return thumbnailImage; }

References thumbnailImage.

importFromDisk()

QDateTime * Photo::importFromDisk

(

QDomNode *

root

)

Builds photo from XML DOM node, returns date modified info from xml.

Definition at line 239 of file photo.cpp.

{
  //create modified date/time object for returning
  QDateTime* modified = new QDateTime[3];
 
  QDomNode node = root->firstChild();
  QDomText val;
  while( !node.isNull() )
  {
    //------------------------------------------------------------
    //photo description
    if( node.isElement() && node.nodeName() == "description" )
    {
      val = node.firstChild().toText();
      if(!val.isNull())
        description = val.nodeValue();
     description.replace("\\"","\"");
    }
    //------------------------------------------------------------
    //image information
    else if( node.isElement() && node.nodeName() == "image" )
    {
      QDomNode childNode = node.firstChild();
      while( !childNode.isNull() )
      {
        //------------------------------------------------------------
        if( childNode.isElement() && childNode.nodeName() == "md5" )
        {
          val = childNode.firstChild().toText();
          if(!val.isNull())
            imageChecksum = val.nodeValue();
        }
        //------------------------------------------------------------
        else if( childNode.isElement() && childNode.nodeName() == "modified" )
        {
          val = childNode.firstChild().toText();
 
          //split value based on spaces, should be 7 fields
          QStringList vals = QStringList::split( QRegExp(" "), val.nodeValue() );
          int i=0;
          int intVals[7];
          QStringList::Iterator it;
          for ( it = vals.begin(); it != vals.end(); ++it )
          {
            //sanity check incase more fields are provided than there should be
            if(i >6)
              break;
 
            intVals[i] = QString(*it).toInt();
            i++;
          }
          modified[0].setDate( QDate(intVals[0], intVals[1], intVals[2]) );
          modified[0].setTime( QTime(intVals[3], intVals[4], intVals[5], intVals[6]) );
        }
        //------------------------------------------------------------
        childNode = childNode.nextSibling();
      }
    }
    //------------------------------------------------------------
    //slideshow information
    else if( node.isElement() && node.nodeName() == "slideshow" )
    {
      QDomNode childNode = node.firstChild();
      while( !childNode.isNull() )
      {
        //------------------------------------------------------------
        if( childNode.isElement() && childNode.nodeName() == "md5" )
        {
          val = childNode.firstChild().toText();
          if(!val.isNull())
            slideshowChecksum = val.nodeValue();
        }
        //------------------------------------------------------------
        else if( childNode.isElement() && childNode.nodeName() == "modified" )
        {
          val = childNode.firstChild().toText();
 
          //split value based on spaces, should be 6 fields
          QStringList vals = QStringList::split( QRegExp(" "), val.nodeValue() );
          int i=0;
          int intVals[7];
          QStringList::Iterator it;
          for ( it = vals.begin(); it != vals.end(); ++it )
          {
            //sanity check incase more fields are provided than there should be
            if(i >6)
              break;
 
            intVals[i] = QString(*it).toInt();
            i++;
          }
          modified[1].setDate( QDate(intVals[0], intVals[1], intVals[2]) );
          modified[1].setTime( QTime(intVals[3], intVals[4], intVals[5], intVals[6]) );
        }
        //------------------------------------------------------------
        childNode = childNode.nextSibling();
      }
    }
    //------------------------------------------------------------
    //slideshow information
    else if( node.isElement() && node.nodeName() == "thumb" )
    {
      QDomNode childNode = node.firstChild();
      while( !childNode.isNull() )
      {
        //------------------------------------------------------------
        if( childNode.isElement() && childNode.nodeName() == "md5" )
        {
          val = childNode.firstChild().toText();
          if(!val.isNull())
            thumbnailChecksum = val.nodeValue();
        }
        //------------------------------------------------------------
        else if( childNode.isElement() && childNode.nodeName() == "modified" )
        {
          val = childNode.firstChild().toText();
 
          //split value based on spaces, should be 6 fields
          QStringList vals = QStringList::split( QRegExp(" "), val.nodeValue() );
          int i=0;
          int intVals[7];
          QStringList::Iterator it;
          for ( it = vals.begin(); it != vals.end(); ++it )
          {
            //sanity check incase more fields are provided than there should be
            if(i >6)
              break;
 
            intVals[i] = QString(*it).toInt();
            i++;
          }
          modified[2].setDate( QDate(intVals[0], intVals[1], intVals[2]) );
          modified[2].setTime( QTime(intVals[3], intVals[4], intVals[5], intVals[6]) );
        }
        //------------------------------------------------------------
        childNode = childNode.nextSibling();
      }
    }
    //------------------------------------------------------------
    //------------------------------------------------------------
    //Handle md5 info as specified in 1.0a and 1.0a2 xml format
    //image md5
    else if( node.isElement() && node.nodeName() == "imageMD5" )
    {
      val = node.firstChild().toText();
      if(!val.isNull())
        imageChecksum = val.nodeValue();
    }
    //------------------------------------------------------------
    //slideshow md5
    else if( node.isElement() && node.nodeName() == "slideMD5" )
    {
      val = node.firstChild().toText();
      if(!val.isNull())
        slideshowChecksum = val.nodeValue();
    }
    //------------------------------------------------------------
    //thumbnail md5
    else if( node.isElement() && node.nodeName() == "thumbMD5" )
    {
      val = node.firstChild().toText();
      if(!val.isNull())
        thumbnailChecksum = val.nodeValue();
    }
    //------------------------------------------------------------
    //------------------------------------------------------------
    //advance to next node
    node = node.nextSibling();
    //------------------------------------------------------------
  }
 
  //return modification dates read in
  return modified;
}

References description, imageChecksum, slideshowChecksum, and thumbnailChecksum.

Referenced by Subalbum::importFromDisk().

originalImageFilename()

QString Photo::originalImageFilename

(

)

orig filename

Definition at line 572 of file photo.cpp.

{
  //determining the an images original filename is tricky
  //if the photo has never been saved check for presence of an _orig file,
  //otherwise use the current filename since the photo has not yet been modified
  if( !getEverSaved() )
  {
    QString tempOrigLocation = imageLocation;
    tempOrigLocation.truncate( imageLocation.length() - 4 );
    tempOrigLocation = tempOrigLocation + "_orig.jpg";
    
    QDir tmpDir;
    if(tmpDir.exists( tempOrigLocation ) )
      return tempOrigLocation;
    else
      return imageLocation;
  }
  //if the photo was previously saved, it's original form could either be:
  //1.) the permanant storage location + _orig
  //2.) the permanant storage location
  else
  {
    QString storedOrigLocation = subalbum->getAlbum()->getSaveLocation() +  
      QString("/img/%1/%2_orig.jpg").arg(initialSubalbumNumber).arg(initialPhotoNumber);
   
    QString lastSavedLocation = subalbum->getAlbum()->getSaveLocation() +  
      QString("/img/%1/%2.jpg").arg(initialSubalbumNumber).arg(initialPhotoNumber);    
    
    QDir tmpDir;
    if(tmpDir.exists( storedOrigLocation ) )
      return storedOrigLocation;
    else
      return lastSavedLocation;
  }
}

References Subalbum::getAlbum(), getEverSaved(), Album::getSaveLocation(), imageLocation, initialPhotoNumber, initialSubalbumNumber, and subalbum.

Referenced by Album::removeStagnantOrigFiles(), EditingInterface::revertCurrentPhoto(), revertPhoto(), and revertPossible().

revertPhoto()

void Photo::revertPhoto

(

)

revert photo to original form

Definition at line 557 of file photo.cpp.

{
  //ignore if revert is not possible
  if(!revertPossible())
    return;
  
  //set image to reverted form
  QString origName = originalImageFilename();
  setImage( origName );
  
  //recently reverted, orig file should be
  //removed during next save since it's redundant
  recentlyReverted = true;
}

References originalImageFilename(), recentlyReverted, revertPossible(), and setImage().

Referenced by EditingInterface::revertCurrentPhoto().

revertPossible()

bool Photo::revertPossible

(

)

can photo be reverted to a differnt original form

Definition at line 537 of file photo.cpp.

{
  //if photo not recently reverted and orig and current filenames differ
  QString newName = getImageFilename();
  QString origName = originalImageFilename();
  
  return ( !recentlyReverted &&
           origName.compare( newName ) !=0 );
}

References getImageFilename(), originalImageFilename(), and recentlyReverted.

Referenced by EditingInterface::currentPhotoRevertable(), and revertPhoto().

rotate270()

void Photo::rotate270

(

)

Rotates image clockwise 270 degrees.

Definition at line 472 of file photo.cpp.

{ applyTransformation( ROTATE_270 ); }

References applyTransformation(), and ROTATE_270.

rotate90()

void Photo::rotate90

(

)

Rotates image clockwise 90 degrees.

Definition at line 471 of file photo.cpp.

{ applyTransformation( ROTATE_90 );  }

References applyTransformation(), and ROTATE_90.

setDescription()

void Photo::setDescription

(

QString

val

)

Sets the description.

Definition at line 210 of file photo.cpp.

{
  //set empty strings as null, takes up less space and necessary
  //to check for string modification
  if( val.isEmpty() )
    val = QString::null;
 
  if(description.compare(val) != 0)
  {
    description = val;
    subalbum->setModified();
  }
}

References description, Subalbum::setModified(), and subalbum.

Referenced by Subalbum::addPhoto(), and PhotoDescEdit::disappear().

setEverSaved()

void Photo::setEverSaved

(

bool

val

)

sets everSaved

Definition at line 535 of file photo.cpp.

{ everSaved = val; }

References everSaved.

Referenced by Album::exportSubalbumImages(), and setImage().

setImage() [1/3]

bool Photo::setImage

(

QString

editedImageFilename

)

Reset photo data after photo editing has taken place.

Slideshow and thumbnail images need to be regenerated.

Definition at line 156 of file photo.cpp.

{
  //if the image has been saved then simply change the image,slideshow/thubnail 
  //filename handles to point to the temporary directory. We don't need to worry about backing up the
  //image because the new version will be written to the temporary directory and the save location
  if( getEverSaved() )
  {
    imageLocation = subalbum->getAlbum()->getTmpDir() + 
                    QString("/%1_%2.jpg").arg(initialSubalbumNumber).arg(initialPhotoNumber);
    slideshowLocation = subalbum->getAlbum()->getTmpDir() + 
                        QString("/%1_%2_slideshow.jpg").arg(initialSubalbumNumber).arg(initialPhotoNumber);
    thumbnailLocation = subalbum->getAlbum()->getTmpDir() + 
                        QString("/%1_%2_thumb.jpg").arg(initialSubalbumNumber).arg(initialPhotoNumber);
  }
  //otherwise image has never been saved, make sure original form has been backed up!
  else
  {
    QString tempOrigLocation = imageLocation;
    tempOrigLocation.truncate( imageLocation.length() - 4 );
    tempOrigLocation = tempOrigLocation + "_orig.jpg";
       
    QDir tmpDir;
    if(!tmpDir.exists( tempOrigLocation ) )
    { copyFile( imageLocation, tempOrigLocation ); }    
  }
  
  //copy over full size image
  copyFile( editedImageFilename, imageLocation );
  
  //reset revert flag since image has not been modified
  recentlyReverted = false;
  
  //construct smaller iamges
  return constructSmallerImages();
}

References constructSmallerImages(), copyFile(), Subalbum::getAlbum(), getEverSaved(), Album::getTmpDir(), imageLocation, initialPhotoNumber, initialSubalbumNumber, recentlyReverted, slideshowLocation, subalbum, and thumbnailLocation.

setImage() [2/3]

bool Photo::setImage	(	QString	imageName,
		int	uniqueID )

Setup photo using a new image. We'll need to create slideshow and thumbnail images.

Definition at line 124 of file photo.cpp.

{ 
  //this is a new photo, use a unique ID to construct temporary filenames
  setEverSaved(false);
  initialSubalbumNumber = 0;
  initialPhotoNumber = uniqueID;
 
  QString tmpDir = subalbum->getAlbum()->getTmpDir();
  imageLocation     = QString("%1/%2_%3.jpg")          .arg(tmpDir).arg(initialSubalbumNumber).arg(initialPhotoNumber);
  slideshowLocation = QString("%1/%2_%3_slideshow.jpg").arg(tmpDir).arg(initialSubalbumNumber).arg(initialPhotoNumber);
  thumbnailLocation = QString("%1/%2_%3_thumb.jpg")    .arg(tmpDir).arg(initialSubalbumNumber).arg(initialPhotoNumber);
  
  //if image in jpeg format simply copy file over
  if( isJpeg(imageName) )
  {
    copyFile( imageName, imageLocation );
  }
  //otherwise we must load it up and save it out as jpeg
  else
  {
    //if unable to open image at all using Qt then giveup
    QImage tempImage(imageName);
    if( tempImage.isNull() ) { return false; }
    
    //save out as jpeg
    tempImage.save( imageLocation, "JPEG", 95 );
  }  
  
  //construct smaller iamges
  return constructSmallerImages();
}

References constructSmallerImages(), copyFile(), Subalbum::getAlbum(), Album::getTmpDir(), imageLocation, initialPhotoNumber, initialSubalbumNumber, isJpeg(), setEverSaved(), slideshowLocation, subalbum, and thumbnailLocation.

setImage() [3/3]

bool Photo::setImage	(	QString	imageName,
		QString	slideshowName,
		QString	thumbnailName )

Setup photo using preexisting full size, slideshow, and thumbnail images.

We call this method when loading photos from disk and resizing is not necessary.

Definition at line 105 of file photo.cpp.

{  
  //set filenames, we'll lazily compute MD5 checksums for files when saving
  imageLocation     = imageName;
  slideshowLocation = slideshowName;
  thumbnailLocation = thumbnailName;
  
  //load thumbnail image
  delete thumbnailImage;
  thumbnailImage = new QImage(thumbnailName);
  if(thumbnailImage->isNull()) return false;
  
  //image just loaded, no changes yet
  needsSaving = false;
  return true;
}

References imageLocation, needsSaving, slideshowLocation, thumbnailImage, and thumbnailLocation.

Referenced by Subalbum::addPhoto(), EditingInterface::applyImageUpdate(), Subalbum::lazyAddPhoto(), revertPhoto(), and EditingInterface::rotateFlip().

setImageChecksum()

void Photo::setImageChecksum

(

QString

val

)

Update image checksum.

Definition at line 204 of file photo.cpp.

{ imageChecksum = val; }

References imageChecksum.

Referenced by Album::exportSubalbumImages().

setImageFilename()

void Photo::setImageFilename

(

QString

val

)

Sets the image filename.

Definition at line 196 of file photo.cpp.

{ imageLocation = val;     }

References imageLocation.

Referenced by Album::exportSubalbumImages(), and Album::reorderSubalbumImages().

setInitialPhotoNumber()

void Photo::setInitialPhotoNumber

(

int

val

)

Sets initial photo number.

Definition at line 609 of file photo.cpp.

{ initialPhotoNumber = val; }

References initialPhotoNumber.

Referenced by Album::reorderSubalbumImages().

setInitialSubalbumNumber()

void Photo::setInitialSubalbumNumber

(

int

val

)

Sets initial subalbum number.

Definition at line 612 of file photo.cpp.

{ initialSubalbumNumber = val; }

References initialSubalbumNumber.

Referenced by Album::reorderSubalbumImages().

setNeedsSavingVal()

void Photo::setNeedsSavingVal

(

bool

val

)

Sets if the image needs to be saved to its permanent location.

Definition at line 532 of file photo.cpp.

{ needsSaving = val; }

References needsSaving.

Referenced by Album::exportSubalbumImages().

setNext()

void Photo::setNext

(

Photo *

val

)

Sets next photo pointer.

Definition at line 233 of file photo.cpp.

{ 
  next = val;
  subalbum->setModified();
}

References next, Subalbum::setModified(), and subalbum.

Referenced by Subalbum::addPhoto(), Subalbum::addPhoto(), Subalbum::lazyAddPhoto(), Subalbum::photoMoved(), Subalbum::removePhoto(), and Subalbum::syncPhotoList().

setPrev()

void Photo::setPrev

(

Photo *

val

)

Sets prev photo pointer.

Definition at line 227 of file photo.cpp.

{ 
  prev = val;
  subalbum->setModified();
}

References prev, Subalbum::setModified(), and subalbum.

Referenced by Subalbum::addPhoto(), Subalbum::addPhoto(), Subalbum::lazyAddPhoto(), Subalbum::photoMoved(), Subalbum::removePhoto(), and Subalbum::syncPhotoList().

setRecentlyReverted()

void Photo::setRecentlyReverted

(

bool

val

)

reset the recently reverted value to val

Definition at line 552 of file photo.cpp.

{
  recentlyReverted = val;
}

References recentlyReverted.

Referenced by Album::removeStagnantOrigFiles().

setSlideshowChecksum()

void Photo::setSlideshowChecksum

(

QString

val

)

Update slideshow checksum.

Definition at line 206 of file photo.cpp.

{ slideshowChecksum = val; }

References slideshowChecksum.

Referenced by Album::exportSubalbumImages().

setSlideshowFilename()

void Photo::setSlideshowFilename

(

QString

val

)

Sets the slideshow filename.

Definition at line 197 of file photo.cpp.

{ slideshowLocation = val; }

References slideshowLocation.

Referenced by Album::exportSubalbumImages(), and Album::reorderSubalbumImages().

setThumbnailChecksum()

void Photo::setThumbnailChecksum

(

QString

val

)

Update thumbnail checksum.

Definition at line 205 of file photo.cpp.

{ thumbnailChecksum = val; }

References thumbnailChecksum.

Referenced by Album::exportSubalbumImages().

setThumbnailFilename()

void Photo::setThumbnailFilename

(

QString

val

)

Sets the thumbnail filename.

Definition at line 198 of file photo.cpp.

{ thumbnailLocation = val; }

References thumbnailLocation.

Referenced by Album::exportSubalbumImages(), and Album::reorderSubalbumImages().

Member Data Documentation

description

QString Photo::description

private

Photo description.

Definition at line 205 of file photo.h.

Referenced by exportToXML(), getDescription(), importFromDisk(), Photo(), and setDescription().

everSaved

bool Photo::everSaved

private

Has the photo ever been saved?

Definition at line 224 of file photo.h.

Referenced by getEverSaved(), Photo(), and setEverSaved().

imageChecksum

QString Photo::imageChecksum

private

MD5 checksums, used to determine if image/thumbnail have been changed.

Definition at line 216 of file photo.h.

Referenced by exportToXML(), getImageChecksum(), importFromDisk(), Photo(), and setImageChecksum().

imageLocation

QString Photo::imageLocation

private

Filenames

Definition at line 211 of file photo.h.

Referenced by applyTransformation(), constructSmallerImages(), getImageFilename(), originalImageFilename(), Photo(), setImage(), setImage(), setImage(), and setImageFilename().

initialPhotoNumber

int Photo::initialPhotoNumber

private

Definition at line 199 of file photo.h.

Referenced by applyTransformation(), getInitialPhotoNumber(), originalImageFilename(), Photo(), setImage(), setImage(), and setInitialPhotoNumber().

initialSubalbumNumber

int Photo::initialSubalbumNumber

private

Definition at line 202 of file photo.h.

Referenced by applyTransformation(), getInitialSubalbumNumber(), originalImageFilename(), Photo(), setImage(), setImage(), and setInitialSubalbumNumber().

needsSaving

bool Photo::needsSaving

private

Unsaved modifications?

Definition at line 221 of file photo.h.

Referenced by applyTransformation(), constructSmallerImages(), getNeedsSavingVal(), Photo(), setImage(), and setNeedsSavingVal().

next

Photo* Photo::next

private

Pointer to next photo.

Definition at line 196 of file photo.h.

Referenced by getNext(), Photo(), and setNext().

prev

Photo* Photo::prev

private

Pointer to prev photo.

Definition at line 193 of file photo.h.

Referenced by getPrev(), Photo(), and setPrev().

recentlyReverted

bool Photo::recentlyReverted

private

Has the photo recently been reverted to it's original form? If so during the next save the orig file can safely be remove.

Definition at line 228 of file photo.h.

Referenced by applyTransformation(), getRecentlyReverted(), Photo(), revertPhoto(), revertPossible(), setImage(), and setRecentlyReverted().

slideshowChecksum

QString Photo::slideshowChecksum

private

Definition at line 217 of file photo.h.

Referenced by exportToXML(), getSlideshowChecksum(), importFromDisk(), Photo(), and setSlideshowChecksum().

slideshowLocation

QString Photo::slideshowLocation

private

Definition at line 212 of file photo.h.

Referenced by applyTransformation(), constructSmallerImages(), getSlideshowFilename(), Photo(), setImage(), setImage(), setImage(), and setSlideshowFilename().

subalbum

Subalbum* Photo::subalbum

private

Subalbum photo is in.

Definition at line 190 of file photo.h.

Referenced by applyTransformation(), constructSmallerImages(), originalImageFilename(), Photo(), setDescription(), setImage(), setImage(), setNext(), and setPrev().

thumbnailChecksum

QString Photo::thumbnailChecksum

private

Definition at line 218 of file photo.h.

Referenced by exportToXML(), getThumbnailChecksum(), importFromDisk(), Photo(), and setThumbnailChecksum().

thumbnailImage

QImage* Photo::thumbnailImage

private

Thumbnail Image.

Definition at line 208 of file photo.h.

Referenced by constructSmallerImages(), getThumbnailImage(), Photo(), setImage(), and ~Photo().

thumbnailLocation

QString Photo::thumbnailLocation

private

Definition at line 213 of file photo.h.

Referenced by applyTransformation(), constructSmallerImages(), getThumbnailFilename(), Photo(), setImage(), setImage(), setImage(), and setThumbnailFilename().

---

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

• photo.h
• photo.cpp