HelpWindow Class Reference

Help window widget. More...

#include <helpWindow.h>

Inheritance diagram for HelpWindow:

Collaboration diagram for HelpWindow:

Signals
void	closed ()

Public Member Functions
	HelpWindow (QWidget *parent=0, const char *name=0)
	~HelpWindow ()

Private Slots
void	setPage (HELP_PAGE page)
void	showFirstSelection ()
void	showCurrentPage ()
void	reject ()

Private Member Functions
void	closeEvent (QCloseEvent *e)

Private Attributes
ALabel *	billboard
Q3TextBrowser *	content
HELP_PAGE	currentPage
Q3MimeSourceFactory *	loadingMimeSource

Detailed Description

Help window widget.

Definition at line 28 of file helpWindow.h.

Constructor & Destructor Documentation

HelpWindow()

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

Definition at line 44 of file helpWindow.cpp.

                                                          : QDialog(parent,name)
{
  //determine necessary encoding for reading and writing to html files
  Q3TextStream::Encoding fileEncoding;
  QString savingCharSet;
  QString loadingCharSet;
 
  //Mac OSX -> Use UTF16
  #if defined(Q_OS_MACX)
  fileEncoding = Q3TextStream::Unicode;
  savingCharSet = "utf16";
  loadingCharSet = "UTF-16";
  
  //Other UNIX or Windows with Unicode support -> Use UTF8
  #elif !defined(Q_WS_WIN) || (defined(Q_WS_WIN) && defined(UNICODE))
  fileEncoding = Q3TextStream::UnicodeUTF8;
  savingCharSet = "utf8";
  loadingCharSet = "UTF-8";
 
  //Windows without Unicode support (Win95/98/ME) -> Use Latin-1
  #else
  fileEncoding = Q3TextStream::Latin1;
  savingCharSet = "latin-1";
  loadingCharSet = "latin-1";
  #endif
  //-------------------------------------------------------------
  //generate html pages
  WhatsNew::generateHTML    (fileEncoding, savingCharSet);
  Importing::generateHTML   (fileEncoding, savingCharSet);
  Annotating::generateHTML  (fileEncoding, savingCharSet);
  Framing::generateHTML     (fileEncoding, savingCharSet);
  Enhancing::generateHTML   (fileEncoding, savingCharSet);
  ProTools::generateHTML    (fileEncoding, savingCharSet);
  Manipulating::generateHTML(fileEncoding, savingCharSet);
  LoadSave::generateHTML    (fileEncoding, savingCharSet);
  Shortcuts::generateHTML   (fileEncoding, savingCharSet);
  
  resize( 800, 400 );
  setPaletteBackgroundColor( QColor(255,255,255) );
 
  //set window title
  setCaption( tr("Album Shaper Help"));
  //--
  //create billboard widget
  billboard = new ALabel( this, "helpBillboard", NULL,
                                  APPEAR_IMMEDIATELY, SLIDE_OUT_LEFT );
  billboard->setPixmap( QPixmap( QString(IMAGE_PATH)+"helpImages/helpBillboard.png") );
  currentPage = BILLBOARD;
  connect( billboard, SIGNAL(pixmapRemoved()),
           this, SLOT(showFirstSelection()) );
 
  //construct special mime source factory for loading html files for the contents and content frames
  loadingMimeSource = new Q3MimeSourceFactory();
  loadingMimeSource->setExtensionType("html",QString("text/html;charset=%1").arg(loadingCharSet) );
 
  //create contents widget
  Contents* contents = new Contents(fileEncoding, savingCharSet, loadingMimeSource, this);
  connect( contents, SIGNAL(setPage(HELP_PAGE)),
           this, SLOT(setPage(HELP_PAGE)) );
 
  //create widget for holding content
  content = new Q3TextBrowser( this );
  content->setHScrollBarMode( Q3ScrollView::Auto );
  content->setVScrollBarMode( Q3ScrollView::Auto );
  content->setFrameStyle( Q3Frame::NoFrame );
  content->setMimeSourceFactory( loadingMimeSource );
  
  //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)
  content->setCornerWidget( new QSizeGrip(this) );
#endif
    
  content->hide();
  //--
  //place items in grid layout
  Q3GridLayout* grid = new Q3GridLayout( this, 4, 3, 0);
  grid->addMultiCellWidget( billboard, 0,2, 0,0, Qt::AlignHCenter | Qt::AlignTop );
  grid->addWidget( contents, 1,1 );
  grid->addMultiCellWidget( content, 0,2, 2,2 );
 
  grid->setRowSpacing( 0, QMAX(billboard->sizeHint().height() - 
                               contents->minimumSizeHint().height(), 0)/2 );
  grid->setColSpacing( 1, contents->minimumSizeHint().width() );
  grid->setRowStretch( 1, 1 );
  grid->setColStretch( 2, 1 );
  //--
  //PLATFORM_SPECIFIC_CODE - Close Button
#if (!defined(Q_OS_WIN) && !defined(Q_OS_MACX))
  QPushButton* closeButton = new QPushButton( tr("Close"), this );
  closeButton->setSizePolicy( QSizePolicy::Fixed, QSizePolicy::Fixed );
  closeButton->setDefault(true);
  connect( closeButton, SIGNAL(clicked()), SLOT(close()) );
  grid->addMultiCellWidget( closeButton, 3,3, 0,2, Qt::AlignCenter );
#endif  
  //--
}

References APPEAR_IMMEDIATELY, BILLBOARD, billboard, content, currentPage, Annotating::generateHTML(), Enhancing::generateHTML(), Framing::generateHTML(), Importing::generateHTML(), LoadSave::generateHTML(), Manipulating::generateHTML(), ProTools::generateHTML(), Shortcuts::generateHTML(), WhatsNew::generateHTML(), IMAGE_PATH, loadingMimeSource, Contents::minimumSizeHint(), setPage(), ALabel::setPixmap(), showFirstSelection(), and SLIDE_OUT_LEFT.

~HelpWindow()

HelpWindow::~HelpWindow

(

)

Definition at line 145 of file helpWindow.cpp.

{
  delete loadingMimeSource;
  loadingMimeSource = NULL;
}

References loadingMimeSource.

Member Function Documentation

closed

void HelpWindow::closed ( )

signal

Referenced by closeEvent(), and reject().

closeEvent()

void HelpWindow::closeEvent ( QCloseEvent * e )

private

Definition at line 151 of file helpWindow.cpp.

{
  QWidget::closeEvent( e );
  emit closed();
}

References closed().

reject

void HelpWindow::reject ( )

privateslot

Definition at line 157 of file helpWindow.cpp.

{
  QDialog::reject();
  emit closed();
}

References closed().

setPage

void HelpWindow::setPage ( HELP_PAGE page )

privateslot

Definition at line 163 of file helpWindow.cpp.

{
  //if billboard stillshown first remove it.
  if( currentPage == BILLBOARD )
  {
    billboard->removePixmap();
    currentPage = page;
    
    //show page only once billboard has finished sliding away to the left
  }
  else
  {
    currentPage = page;
    showCurrentPage();
  }
}

References BILLBOARD, billboard, currentPage, ALabel::removePixmap(), and showCurrentPage().

Referenced by HelpWindow().

showCurrentPage

void HelpWindow::showCurrentPage ( )

privateslot

Definition at line 186 of file helpWindow.cpp.

{
  if( currentPage == KEYBOARD_SHORTCUTS )
    content->setSource( Shortcuts::filename() );
  else if( currentPage == WHATS_NEW )
    content->setSource( WhatsNew::filename() );
 
  else if( currentPage == IMPORTING_AND_ORGANIZING )
    content->setSource( Importing::filename() );
  else if( currentPage == ANNOTATING_ALBUMS )
    content->setSource( Annotating::filename() );
  else if( currentPage == FRAMING )
    content->setSource( Framing::filename() );
  else if( currentPage == ENHANCING )
    content->setSource( Enhancing::filename() );
  else if( currentPage == PRO_TOOLS )
    content->setSource( ProTools::filename() );
  else if( currentPage == MANIPULATING )
    content->setSource( Manipulating::filename() );
  else if( currentPage == SAVING_AND_LOADING )
    content->setSource( LoadSave::filename() );
  else
    content->setText("");
  
  content->setFocus();
}

References ANNOTATING_ALBUMS, content, currentPage, ENHANCING, Annotating::filename(), Enhancing::filename(), Framing::filename(), Importing::filename(), LoadSave::filename(), Manipulating::filename(), ProTools::filename(), Shortcuts::filename(), WhatsNew::filename(), FRAMING, IMPORTING_AND_ORGANIZING, KEYBOARD_SHORTCUTS, MANIPULATING, PRO_TOOLS, SAVING_AND_LOADING, and WHATS_NEW.

Referenced by setPage(), and showFirstSelection().

showFirstSelection

void HelpWindow::showFirstSelection ( )

privateslot

Definition at line 180 of file helpWindow.cpp.

{
  content->show();
  showCurrentPage();
}

References content, and showCurrentPage().

Referenced by HelpWindow().

Member Data Documentation

billboard

ALabel* HelpWindow::billboard

private

Definition at line 48 of file helpWindow.h.

Referenced by HelpWindow(), and setPage().

content

Q3TextBrowser* HelpWindow::content

private

Definition at line 49 of file helpWindow.h.

Referenced by HelpWindow(), showCurrentPage(), and showFirstSelection().

currentPage

HELP_PAGE HelpWindow::currentPage

private

Definition at line 51 of file helpWindow.h.

Referenced by HelpWindow(), setPage(), and showCurrentPage().

loadingMimeSource

Q3MimeSourceFactory* HelpWindow::loadingMimeSource

private

Definition at line 53 of file helpWindow.h.

Referenced by HelpWindow(), and ~HelpWindow().

---

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

• helpWindow.h
• helpWindow.cpp