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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Kurtis Nusbaum (klnusbaum@gmail.com) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 #ifndef OPTIKA_GUI_HPP_
00029 #define OPTIKA_GUI_HPP_
00030 
00031 #include "Optika_metawindow.hpp"
00032 
00039 namespace Optika{
00040 
00042 
00043 
00057   void getInput(
00058     RCP<ParameterList> validParameters,
00059     RCP<DependencySheet> dependencySheet=null,
00060     void (*customFunc)(RCP<const ParameterList>)=NULL);
00061 
00075   void getInput(
00076     const std::string& nameOfXmlFile,
00077     RCP<ParameterList>& userInput,
00078     void (*customFunc)(RCP<const ParameterList>)=NULL);
00079 
00081 
00085 class OptikaGUI{
00086 public:
00089 
00100   OptikaGUI(
00101     RCP<ParameterList> validParameters, 
00102     RCP<DependencySheet> dependencySheet=null,
00103     void (*customFunc)(RCP<const ParameterList>)=NULL);
00104 
00112   OptikaGUI(const std::string& xmlFileName,
00113     void (*customFunc)(RCP<const ParameterList>)=NULL);
00114 
00116 
00118 
00119   
00123   void exec();
00124 
00126 
00128 
00129   
00135   void setAboutInfo(const std::string& aboutInfo);
00136 
00142   void setActionButtonText(const std::string& text);
00143 
00150   void setWindowTitle(const std::string& title);
00151 
00158   void setWindowIcon(const std::string& filePath);
00159 
00166   void setStyleSheet(const std::string& filePath);
00167 
00175   void setCustomFunction(void (*customFunc)(RCP<const ParameterList>));
00176 
00182   std::string getWindowTitle();
00183 
00191   std::string getWindowIcon();
00192 
00200   std::string getStyleSheet();
00201 
00207   std::string getAboutInfo();
00208 
00210 
00211 private:
00214   
00218   RCP<ParameterList> validParameters;
00219 
00223   RCP<DependencySheet> dependencySheet;
00224 
00228   std::string title;
00229 
00233   std::string iconFilePath;
00234 
00238   std::string styleSheetFilePath;
00239 
00243   std::string aboutInfo;
00244 
00248   std::string actionButtonText;
00249 
00253   void (*customFunc)(RCP<const ParameterList>);
00254 
00256 };
00257 
00258 }
00259 
00260 #endif //OPTIKA_GUI_HPP_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Defines