Optika GUI Toolik Version of the Day
Optika_GUI.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //         Optika: A Tool For Developing Parameter Obtaining GUIs
00005 //                Copyright (2009) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, with Sandia Corporation, the 
00008 // U.S. Government retains certain rights in this software.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Kurtis Nusbaum (klnusbaum@gmail.com) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 #ifndef OPTIKA_GUI_HPP_
00042 #define OPTIKA_GUI_HPP_
00043 
00044 #include "Optika_metawindow.hpp"
00045 
00052 namespace Optika{
00053 
00055 
00056 
00070   void getInput(
00071     RCP<ParameterList> validParameters,
00072     RCP<DependencySheet> dependencySheet=null,
00073     void (*customFunc)(RCP<const ParameterList>)=NULL);
00074 
00088   void getInput(
00089     const std::string& nameOfXmlFile,
00090     RCP<ParameterList>& userInput,
00091     void (*customFunc)(RCP<const ParameterList>)=NULL);
00092 
00110   void getInputExtraOptions(
00111     RCP<ParameterList> validParameters,
00112     RCP<DependencySheet> dependencySheet=null,
00113     std::string styleSheetFilePath = "",
00114     std::string iconFilePath = "",
00115     void (*customFunc)(RCP<const ParameterList>)=NULL);
00116 
00134   void getInputExtraOptions(
00135     const std::string& nameOfXmlFile,
00136     RCP<ParameterList>& userInput,
00137     std::string styleSheetFilePath = "",
00138     std::string iconFilePath = "",
00139     void (*customFunc)(RCP<const ParameterList>)=NULL);
00140 
00141 
00143 
00147 class OptikaGUI{
00148 public:
00151 
00162   OptikaGUI(
00163     RCP<ParameterList> validParameters, 
00164     RCP<DependencySheet> dependencySheet=null,
00165     void (*customFunc)(RCP<const ParameterList>)=NULL);
00166 
00174   OptikaGUI(const std::string& xmlFileName,
00175     void (*customFunc)(RCP<const ParameterList>)=NULL);
00176 
00178 
00180 
00181   
00185   void exec();
00186 
00188 
00190 
00191   
00197   void setAboutInfo(const std::string& aboutInfo);
00198 
00204   void setActionButtonText(const std::string& text);
00205 
00212   void setWindowTitle(const std::string& title);
00213 
00220   void setWindowIcon(const std::string& filePath);
00221 
00228   void setStyleSheet(const std::string& filePath);
00229 
00237   void setCustomFunction(void (*customFunc)(RCP<const ParameterList>));
00238 
00244   std::string getWindowTitle();
00245 
00253   std::string getWindowIcon();
00254 
00262   std::string getStyleSheet();
00263 
00269   std::string getAboutInfo();
00270 
00272 
00273 private:
00276   
00280   RCP<ParameterList> validParameters;
00281 
00285   RCP<DependencySheet> dependencySheet;
00286 
00290   std::string title;
00291 
00295   std::string iconFilePath;
00296 
00300   std::string styleSheetFilePath;
00301 
00305   std::string aboutInfo;
00306 
00310   std::string actionButtonText;
00311 
00315   void (*customFunc)(RCP<const ParameterList>);
00316 
00318 };
00319 
00320 }
00321 
00322 #endif //OPTIKA_GUI_HPP_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Defines