rtVTK  0.6.0
Documentation.h
00001 
00002 /******************************************************************************
00003  * Copyright (c) 2012, Grove City College
00004  * All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions are
00008  * met:
00009  * 
00010  *  * Redistributions of source code must retain the above copyright
00011  *    notice, this list of conditions and the following disclaimer.
00012  *
00013  *  * Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in
00015  *    the documentation and/or other materials provided with the
00016  *    distribution.
00017  *
00018  *  * Neither the name of Grove City College nor the names of its
00019  *    contributors may be used to endorse or promote products derived
00020  *    from this software without specific prior written permission.
00021  *
00022  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00023  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00024  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00025  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
00026  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00027  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00028  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00029  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00030  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00031  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00032  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033  *
00034  */
00035 
00036 
00041 #ifndef StandAlone_Documentation_h
00042 #define StandAlone_Documentation_h
00043 
00044 #include <QMainWindow>
00045 
00046 // NOTE(cpg) - ui_Documentation.h is an auto-generated file, so use relative
00047 //             pathname
00048 #include "ui_Documentation.h"
00049 
00050 // Forward Declarations
00051 class QCloseEvent;
00052 class QShortcut;
00053 class QShowEvent;
00054 class QToolButton;
00055 
00056 
00057 namespace rtVTK
00058 {
00060   class Documentation : public QMainWindow
00061   {
00062     Q_OBJECT
00063   public:
00064     explicit Documentation(QMainWindow* = 0);
00065     explicit Documentation(const QUrl&, QMainWindow* = 0);
00066     ~Documentation();
00067     void setPath(const QUrl&);
00068 
00069   signals:
00070     void sgnlRestoreIdle();
00071     void sgnlDisableIdle();
00072     void sgnlPauseTimers();
00073     void sgnlUnpauseTimers();
00074 
00075   private:
00076     void showEvent(QShowEvent*);
00077     void closeEvent(QCloseEvent*);
00078 
00079     Ui::Documentation* ui;
00080 
00081     QShortcut* escapeOverloaded;
00082 
00087     QToolButton* backButton;
00088     QToolButton* forwardButton;
00090   };
00091 
00092 } // namespace rtVTK
00093 
00094 #endif // StandAlone_Documentation_h
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends