StatusWidget Class Reference

#include <statusWidget.h>

Inheritance diagram for StatusWidget:

Collaboration diagram for StatusWidget:

Public Member Functions
	StatusWidget (QWidget *parent=0, const char *name=0)
	Creates layout.
	~StatusWidget ()
	Deletes all objects.
void	showProgressBar (QString message, int numSteps)
	Initializes the progress bar.
void	updateProgress (int progress, QString newMessage=QString::null)
	Updates the progress bar.
int	currentProgress ()
	Returns current progress in steps.
void	incrementProgress ()
	Updates the progress bar by one step.
void	setStatus (QString message)
	Update message.
void	checkForUpdates ()
	Check for updates.
void	removeUpdatesIcon ()
	Remove program updates icon.
void	grabInput ()
void	releaseInput ()

Private Slots
void	fileFetched (bool error)
	called once a file is fetched from the network
void	removeStatus ()
	Unset message.

Private Attributes
Q3GridLayout *	grid
	Layout widgets placed in.
QLabel *	message
Q3ProgressBar *	progressBar
int	curStep
QTimer *	timer
Q3Http	http
	http object for fetching releases file, used to check to see if installed copy is up to date
ClickableLabel *	updateAvailable
	Update available label.

Detailed Description

Definition at line 32 of file statusWidget.h.

Constructor & Destructor Documentation

StatusWidget()

StatusWidget::StatusWidget	(	QWidget *	parent = 0,
		const char *	name = 0 )

Creates layout.

Definition at line 39 of file statusWidget.cpp.

                                            : QWidget(parent,name)
{
 //create status message
  message = new QLabel( this );
  message->setText( "" );
  
  //create timer object and setup signals
  timer = new QTimer();
  connect(timer, SIGNAL(timeout()), this, SLOT(removeStatus()) );
 
  //create progress message and bar
  progressBar = new Q3ProgressBar( this );
  progressBar->setCenterIndicator(true);
  progressBar->hide();
  curStep = 0;
 
  //-----------------------------------------------------------------
  //setup http object to check for updates, only check for updates if they are enabled
  updateAvailable = NULL;
  http.setHost( "albumshaper.sourceforge.net" );
  connect( &http, SIGNAL(done(bool)), this, SLOT(fileFetched(bool)) );
  if(((Window*)parentWidget())->getConfig()->getBool( "alerts", "showSoftwareUpdateAlerts"))
  {
    checkForUpdates();
  }
  //-----------------------------------------------------------------
  //place progress frame and status message in main grid
  grid = new Q3GridLayout( this, 1, 6, 0 );
  grid->setSpacing(WIDGET_SPACING);
  grid->setColSpacing( 0, WIDGET_SPACING );
  grid->addWidget( message, 0, 1, Qt::AlignVCenter );
  grid->addWidget( progressBar, 0, 2, Qt::AlignVCenter );
  grid->setColStretch( 3, 1 );
 
  //PLATFORM_SPECIFIC_CODE
  //mac os x puts in a size grip that can interfere with the updates icon, in order
  //to avoid this we manually place the size grip ourselves
  //windows users expect a grip too, but qt doesn't put one in by default. we'll add
  //it for them too. :-)
  #if defined(Q_OS_MACX) || defined(Q_OS_WIN)
  QSizeGrip* sizeGrip = new QSizeGrip( this );
  grid->addWidget( sizeGrip, 0, 5, Qt::AlignBottom );
  #endif
 
}

References checkForUpdates(), curStep, fileFetched(), grid, http, message, progressBar, removeStatus(), timer, updateAvailable, and WIDGET_SPACING.

~StatusWidget()

StatusWidget::~StatusWidget

(

)

Deletes all objects.

Definition at line 86 of file statusWidget.cpp.

{
  delete timer;
  timer = NULL;
}

References timer.

Member Function Documentation

checkForUpdates()

void StatusWidget::checkForUpdates

(

)

Check for updates.

Definition at line 230 of file statusWidget.cpp.

{
  if(updateAvailable != NULL)
    return;
 
  //attempt to get releases list from website. this lets us find out if this
  //copy of Album Shaper is outdated
  http.get( "/webService/releases.xml");
}

References http, and updateAvailable.

Referenced by StatusWidget().

currentProgress()

int StatusWidget::currentProgress

(

)

Returns current progress in steps.

Definition at line 117 of file statusWidget.cpp.

{
  return curStep;
}

References curStep.

fileFetched

void StatusWidget::fileFetched ( bool error )

privateslot

called once a file is fetched from the network

Definition at line 147 of file statusWidget.cpp.

{
  //------------------------------------------------------------
  //if unable to get file bail
  if(error)
  {
    return;
  }
  //------------------------------------------------------------
  //write releases to temp file
  QFile fetchedDoc( TEMP_DIR + QString("/releases.xml") );
  if(fetchedDoc.open(QIODevice::WriteOnly))
  {
    //----------------------------
    //write to file
    Q3TextStream stream( &fetchedDoc );
    stream.setEncoding( Q3TextStream::UnicodeUTF8 );
    stream << QString( http.readAll() );
    fetchedDoc.close();
    //----------------------------
    //parse xml file, construct string list of releases
    //open file, bail if unable to
    if( !fetchedDoc.open( QIODevice::ReadOnly ) )
    {
      return;
    }
 
    //parse dom
    QDomDocument xmlDom;
    if( !xmlDom.setContent( &fetchedDoc ) )
    {
      fetchedDoc.close();
      return;
    }
 
    //close file
    fetchedDoc.close();
 
    //construct stringlist of releases
    //actually, only get the first release since we don't need the others to determine if we
    //are out of date
 
    QStringList releases;
    QDomElement root = xmlDom.documentElement();
    QDomNode node = root.firstChild();
    QDomText val;
    bool thisVersionFound = false;
    while( !node.isNull() )
    {
      if( node.isElement() && node.nodeName() == "release" )
      {
        val = node.firstChild().toText();
        if(!val.isNull())
        {
          //append release #
          releases.append( QString(val.nodeValue()) );
 
          //is release this version?
          if( QString(val.nodeValue()).compare( QString(ALBUMSHAPER_VERSION) ) == 0 )
            thisVersionFound = true;
        }
      }
      node = node.nextSibling();
    }
 
    //compare first release to this release, if strings not equal then we're outdated,
    //update album shaper icon and start grabbing changelogs
    if(thisVersionFound && releases.first().compare( QString(ALBUMSHAPER_VERSION) ) != 0)
    {
      ClickableLabel* uA = new ClickableLabel( this );
      QMovie *m = new QMovie( QString(IMAGE_PATH)+"miscImages/updateAvailable.mng");
      uA->setMovie(m);
      QToolTip::add( uA, tr("Your copy of Album Shaper is not up to date! Click here for details") );
      grid->addWidget( uA, 0, 4, Qt::AlignVCenter );
      connect( uA, SIGNAL(clicked()),
                    ((Window*)parentWidget())->getTitle(), SLOT(aboutProgram()) );
      uA->show();\
      updateAvailable = uA;
    }
  }
  //------------------------------------------------------------
}

References ALBUMSHAPER_VERSION, grid, http, IMAGE_PATH, TEMP_DIR, and updateAvailable.

Referenced by StatusWidget().

grabInput()

void StatusWidget::grabInput

(

)

Definition at line 246 of file statusWidget.cpp.

{
  grabKeyboard();
  grabMouse(); 
}

Referenced by EditingInterface::adjustGrain(), EditingInterface::applyEffect(), EditingInterface::colorBalance(), EditingInterface::crop(), EditingInterface::enhanceContrast(), EditingInterface::finishCorrectTilt(), TitleWidget::loadAlbum(), EditingInterface::removeRedeye(), EditingInterface::revertCurrentPhoto(), EditingInterface::rotateFlip(), and EditingInterface::tuneLevels().

incrementProgress()

void StatusWidget::incrementProgress

(

)

Updates the progress bar by one step.

Definition at line 122 of file statusWidget.cpp.

{
  curStep++;
  progressBar->setProgress( curStep );
}

References curStep, and progressBar.

Referenced by blackWhiteEffect(), correctImageTilt(), embossEffect(), enhanceImageContrast(), Album::exportSubalbumImages(), findRegionOfInterest(), Subalbum::importFromDisk(), improveColorBalance(), mosaicEffect(), oilPaintingEffect(), Album::removeStagnantOrigFiles(), Album::reorderSubalbumImages(), and sepiaEffect().

releaseInput()

void StatusWidget::releaseInput

(

)

Definition at line 252 of file statusWidget.cpp.

{
  releaseKeyboard();
  releaseMouse();
}

Referenced by EditingInterface::adjustGrain(), EditingInterface::applyEffect(), EditingInterface::colorBalance(), EditingInterface::crop(), EditingInterface::enhanceContrast(), EditingInterface::finishCorrectTilt(), TitleWidget::loadAlbum(), EditingInterface::removeRedeye(), EditingInterface::revertCurrentPhoto(), EditingInterface::rotateFlip(), and EditingInterface::tuneLevels().

removeStatus

void StatusWidget::removeStatus ( )

privateslot

Unset message.

Definition at line 141 of file statusWidget.cpp.

{
  //set status message to empty string
  message->setText( "" );
}

References message.

Referenced by StatusWidget().

removeUpdatesIcon()

void StatusWidget::removeUpdatesIcon

(

)

Remove program updates icon.

Definition at line 240 of file statusWidget.cpp.

{
  delete updateAvailable;
  updateAvailable = NULL;
}

References updateAvailable.

setStatus()

void StatusWidget::setStatus

(

QString

message

)

Update message.

Definition at line 128 of file statusWidget.cpp.

{
  timer->stop();
 
  //hide progress bar
  progressBar->hide();
 
  //update status message
  this->message->setText( message );
 
  timer->start( 2000, TRUE );
}

References message, progressBar, and timer.

Referenced by SubalbumWidget::addImageAction(), EditingInterface::applyEffect(), correctImageTilt(), enhanceImageContrast(), TitleWidget::exportLargeImages(), TitleWidget::exportSmallWebGallery(), Album::exportToDisk(), Album::importFromDisk(), improveColorBalance(), removeRedeyeRegions(), SubalbumWidget::rotate270ImageAction(), and SubalbumWidget::rotate90ImageAction().

showProgressBar()

void StatusWidget::showProgressBar	(	QString	message,
		int	numSteps )

Initializes the progress bar.

Definition at line 92 of file statusWidget.cpp.

{
  //make sure timer is stopped so progress mess is never hidden
  //this can occur if a new event is begun before the previous events message is removed after default delay
  timer->stop();
  
  //setup progress bar and show it
  this->message->setText( message );
  progressBar->setProgress( 0, numSteps );
  progressBar->show();
  curStep = 0;
}

References curStep, message, progressBar, and timer.

Referenced by SubalbumWidget::addImageAction(), EditingInterface::applyEffect(), blackWhiteEffect(), correctImageTilt(), embossEffect(), enhanceImageContrast(), TitleWidget::exportLargeImages(), TitleWidget::exportSmallWebGallery(), Album::exportToDisk(), Album::importFromDisk(), improveColorBalance(), mosaicEffect(), oilPaintingEffect(), removeRedeyeRegions(), SubalbumWidget::rotate270ImageAction(), SubalbumWidget::rotate90ImageAction(), and sepiaEffect().

updateProgress()

void StatusWidget::updateProgress	(	int	progress,
		QString	newMessage = QString::null )

Updates the progress bar.

Definition at line 105 of file statusWidget.cpp.

{
  curStep = progress;
  progressBar->setProgress( progress );
 
  //update message if provided
  if(newMessage != QString::null)
  {
    this->message->setText( newMessage );
  }
}

References curStep, message, and progressBar.

Referenced by SubalbumWidget::addImageAction(), Album::exportCompressedWebAlbum(), Album::exportLargeImages(), SubalbumWidget::rotate270ImageAction(), and SubalbumWidget::rotate90ImageAction().

Member Data Documentation

curStep

int StatusWidget::curStep

private

Definition at line 84 of file statusWidget.h.

Referenced by currentProgress(), incrementProgress(), showProgressBar(), StatusWidget(), and updateProgress().

grid

Q3GridLayout* StatusWidget::grid

private

Layout widgets placed in.

Definition at line 80 of file statusWidget.h.

Referenced by fileFetched(), and StatusWidget().

http

Q3Http StatusWidget::http

private

http object for fetching releases file, used to check to see if installed copy is up to date

Definition at line 89 of file statusWidget.h.

Referenced by checkForUpdates(), fileFetched(), and StatusWidget().

message

QLabel* StatusWidget::message

private

Definition at line 82 of file statusWidget.h.

Referenced by removeStatus(), setStatus(), showProgressBar(), StatusWidget(), and updateProgress().

progressBar

Q3ProgressBar* StatusWidget::progressBar

private

Definition at line 83 of file statusWidget.h.

Referenced by incrementProgress(), setStatus(), showProgressBar(), StatusWidget(), and updateProgress().

timer

QTimer* StatusWidget::timer

private

Definition at line 86 of file statusWidget.h.

Referenced by setStatus(), showProgressBar(), StatusWidget(), and ~StatusWidget().

updateAvailable

ClickableLabel* StatusWidget::updateAvailable

private

Update available label.

Definition at line 92 of file statusWidget.h.

Referenced by checkForUpdates(), fileFetched(), removeUpdatesIcon(), and StatusWidget().

---

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

• statusWidget.h
• statusWidget.cpp