#include <contents.h>

Inheritance diagram for Contents:

Collaboration diagram for Contents:

Signals
void	setPage (HELP_PAGE page)

Public Member Functions
	Contents (Q3TextStream::Encoding type, QString saveCharSet, Q3MimeSourceFactory loadingMimeSource, QWidget parent=0, const char *name=0)

QSize	minimumSizeHint () const

Private Slots
void	handleAnchorClick (const QString &name, const QString &link)

Private Member Functions
QString	filename ()

void	generateHTML (Q3TextStream::Encoding type, QString charSet)

void	printLink (Q3TextStream &stream, QString text, HELP_PAGE anchor, QString anchorString)

Private Attributes
QSize	optimalSize

HELP_PAGE	currentPage

Q3TextStream::Encoding	type

QString	saveCharSet

Detailed Description

Definition at line 40 of file contents.h.

Constructor & Destructor Documentation

◆ Contents()

Contents::Contents	(	Q3TextStream::Encoding	type,
		QString	saveCharSet,
		Q3MimeSourceFactory *	loadingMimeSource,
		QWidget *	parent = 0,
		const char *	name = 0 )

Definition at line 26 of file contents.cpp.

                                                        : Q3TextBrowser(parent,name)
{
  this->type = type;
  this->saveCharSet = saveCharSet;
  this->setMimeSourceFactory( loadingMimeSource );
  
  //generate HTML
  currentPage = BILLBOARD;
  generateHTML(type, saveCharSet);
  //--
  //set browser and load contents
  setHScrollBarMode( Q3ScrollView::AlwaysOff );
  setVScrollBarMode( Q3ScrollView::AlwaysOff );
  setFrameStyle( Q3Frame::NoFrame );
  setSource( filename() );
  
  //------
  //determine optimal size
  int minH = heightForWidth( 1000 );
  int w;
  for(w=1; w<1000; w++)
  {
    if(heightForWidth(w) == minH ) break;
  }
  
  optimalSize = QSize( w, heightForWidth(w) ); 
  //------
  //handle anchor clicks
  connect( this, SIGNAL(anchorClicked(const QString&, const QString&)),
           this, SLOT(handleAnchorClick(const QString&, const QString&)) );
  //------
}

References BILLBOARD, currentPage, filename(), generateHTML(), handleAnchorClick(), optimalSize, saveCharSet, and type.

Member Function Documentation

◆ filename()

QString Contents::filename ( )

private

Definition at line 100 of file contents.cpp.

{
  return QString("%1/helpContents.html").arg(TEMP_DIR);
}

References TEMP_DIR.

Referenced by Contents(), and generateHTML().

◆ generateHTML()

void Contents::generateHTML	(	Q3TextStream::Encoding	type,
		QString	charSet )

private

Definition at line 105 of file contents.cpp.

{
  //create/open html file
  QFile file( filename() );
  if(file.open(QIODevice::WriteOnly))
  {
    //-----
    Q3TextStream stream;
    stream.setEncoding( type );
    stream.setDevice( &file );
    //-----
    stream << "<html><head>\n";
    stream << "<meta http-equiv='Content-Type' content='text/html; charset=" << charSet << "'>\n";
    stream << "</head><body>\n";
    stream << "<center><table><tr><td>\n";
    stream << "<font face='Arial, sans-serif' size='+1'><b>\n";
    //-----    
    printLink( stream, QString(tr("What's New")), WHATS_NEW, "WHATS_NEW" );
    //-----    
    stream << "<p>" << tr("Tutorials:") << "\n";
    //------    
    stream << "<font size='+0'><ul>\n";
 
    stream << "<li>\n";
    printLink( stream, QString(tr("Import & Organize")), 
               IMPORTING_AND_ORGANIZING, "IMPORTING_AND_ORGANIZING" );
    //------    
    stream << "<li>\n";
    printLink( stream, QString(tr("Annotating Albums")), 
               ANNOTATING_ALBUMS, "ANNOTATING_ALBUMS" );
    //------    
    stream << "<li>" << tr("Editing Photos:") << "\n";
 
    stream << "<ol>\n";
    stream << "<li>\n";
    printLink( stream, QString(tr("Framing")), 
               FRAMING, "FRAMING" );
    
    stream << "<li>\n";
    printLink( stream, QString(tr("Fix it Fast")), 
               ENHANCING, "ENHANCING" );
    
    stream << "<li>\n";
    printLink( stream, QString(tr("Pro Tools")), 
               PRO_TOOLS, "PRO_TOOLS" );
 
    stream << "<li>\n";
    printLink( stream, QString(tr("Manipulations")), 
               MANIPULATING, "MANIPULATING" );
    stream << "</ol>\n";
    //------    
    stream << "<li>\n";
    printLink( stream, QString(tr("Saving & Loading")), 
               SAVING_AND_LOADING, "SAVING_AND_LOADING" );
    //------    
    stream << "</ul></font>\n";
    //------    
    printLink( stream, QString(tr("Keyboard Shortcuts")), KEYBOARD_SHORTCUTS, "KEYBOARD_SHORTCUTS" );
    //------    
    stream << "</b></font>\n";
    stream << "</td></tr></table></center>\n";
    stream << "</body></html>\n";
    file.close();
  }
}

References ANNOTATING_ALBUMS, ENHANCING, filename(), FRAMING, IMPORTING_AND_ORGANIZING, KEYBOARD_SHORTCUTS, MANIPULATING, printLink(), PRO_TOOLS, SAVING_AND_LOADING, type, and WHATS_NEW.

Referenced by Contents(), and handleAnchorClick().

◆ handleAnchorClick

void Contents::handleAnchorClick	(	const QString &	name,
		const QString &	link )

privateslot

Definition at line 66 of file contents.cpp.

{
  HELP_PAGE nextPage = INVALID;  
 
  //only handle clicking on anchors with actual names
  if( name.isNull() ) return;
  else if(name.compare("WHATS_NEW") == 0) 
    nextPage = WHATS_NEW;
  else if(name.compare("IMPORTING_AND_ORGANIZING") == 0) 
    nextPage = IMPORTING_AND_ORGANIZING;
  else if(name.compare("ANNOTATING_ALBUMS") == 0) 
    nextPage = ANNOTATING_ALBUMS;
  else if(name.compare("FRAMING") == 0) 
    nextPage = FRAMING;
  else if(name.compare("ENHANCING") == 0) 
    nextPage = ENHANCING;
  else if(name.compare("PRO_TOOLS") == 0) 
    nextPage = PRO_TOOLS;
  else if(name.compare("MANIPULATING") == 0) 
    nextPage = MANIPULATING;
  else if(name.compare("SAVING_AND_LOADING") == 0) 
    nextPage = SAVING_AND_LOADING;
  else if(name.compare("KEYBOARD_SHORTCUTS") == 0) 
    nextPage = KEYBOARD_SHORTCUTS;
 
  if(nextPage != INVALID)
  {
    currentPage = nextPage;
    generateHTML(type, saveCharSet);
    reload();
    emit setPage( currentPage );
  }
}

References ANNOTATING_ALBUMS, currentPage, ENHANCING, FRAMING, generateHTML(), IMPORTING_AND_ORGANIZING, INVALID, KEYBOARD_SHORTCUTS, MANIPULATING, PRO_TOOLS, saveCharSet, SAVING_AND_LOADING, setPage(), type, and WHATS_NEW.

Referenced by Contents().

◆ minimumSizeHint()

QSize Contents::minimumSizeHint ( ) const

Definition at line 61 of file contents.cpp.

{
  return optimalSize;
}

References optimalSize.

Referenced by HelpWindow::HelpWindow().

◆ printLink()

void Contents::printLink	(	Q3TextStream &	stream,
		QString	text,
		HELP_PAGE	anchor,
		QString	anchorString )

private

Definition at line 171 of file contents.cpp.

{
  if( currentPage != anchor ) 
  {
    stream << "<font color='" << LINK_COLOR << "'>";
    stream << "<a name='" << anchorString << "'>";
  }
  else
  {
    stream << "<font color='" << CURR_COLOR << "'>";
  }
 
  stream << text << "\n";
  
  if( currentPage != anchor ) 
  {
    stream << "</a>";
  }
  stream << "</font>\n";
}

References CURR_COLOR, currentPage, and LINK_COLOR.

Referenced by generateHTML().

◆ setPage

void Contents::setPage ( HELP_PAGE page )

signal

Referenced by handleAnchorClick().

Member Data Documentation

◆ currentPage

HELP_PAGE Contents::currentPage

private

Definition at line 56 of file contents.h.

Referenced by Contents(), handleAnchorClick(), and printLink().

◆ optimalSize

QSize Contents::optimalSize

private

Definition at line 52 of file contents.h.

Referenced by Contents(), and minimumSizeHint().

◆ saveCharSet

QString Contents::saveCharSet

private

Definition at line 59 of file contents.h.

Referenced by Contents(), and handleAnchorClick().

◆ type

Q3TextStream::Encoding Contents::type

private

Definition at line 58 of file contents.h.

Referenced by Contents(), generateHTML(), and handleAnchorClick().

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

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Contents()

Member Function Documentation

◆ filename()

◆ generateHTML()

◆ handleAnchorClick

◆ minimumSizeHint()

◆ printLink()

◆ setPage

Member Data Documentation

◆ currentPage

◆ optimalSize

◆ saveCharSet

◆ type