Documentation.h

/******************************************************************************
 * Copyright (c) 2012, Grove City College
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 *  * Neither the name of Grove City College nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */


#ifndef StandAlone_Documentation_h
#define StandAlone_Documentation_h

#include <QMainWindow>

// NOTE(cpg) - ui_Documentation.h is an auto-generated file, so use relative
//             pathname
#include "ui_Documentation.h"

// Forward Declarations
class QCloseEvent;
class QShortcut;
class QShowEvent;
class QToolButton;


namespace rtVTK
{
  class Documentation : public QMainWindow
  {
    Q_OBJECT
  public:
    explicit Documentation(QMainWindow* = 0);
    explicit Documentation(const QUrl&, QMainWindow* = 0);
    ~Documentation();
    void setPath(const QUrl&);

  signals:
    void sgnlRestoreIdle();
    void sgnlDisableIdle();
    void sgnlPauseTimers();
    void sgnlUnpauseTimers();

  private:
    void showEvent(QShowEvent*);
    void closeEvent(QCloseEvent*);

    Ui::Documentation* ui;

    QShortcut* escapeOverloaded;

    QToolButton* backButton;
    QToolButton* forwardButton;
  };

} // namespace rtVTK

#endif // StandAlone_Documentation_h