Optika_GUI.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//         Optika: A Tool For Developing Parameter Obtaining GUIs
//                Copyright (2009) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, with Sandia Corporation, the 
// U.S. Government retains certain rights in this software.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "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 SANDIA CORPORATION OR THE
// 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.
//
// Questions? Contact Kurtis Nusbaum (klnusbaum@gmail.com) 
// 
// ***********************************************************************
// @HEADER
#ifndef OPTIKA_GUI_HPP_
#define OPTIKA_GUI_HPP_

#include "Optika_metawindow.hpp"

namespace Optika{



  void getInput(
    RCP<ParameterList> validParameters,
    RCP<DependencySheet> dependencySheet=null,
    void (*customFunc)(RCP<const ParameterList>)=NULL);

  void getInput(
    const std::string& nameOfXmlFile,
    RCP<ParameterList>& userInput,
    void (*customFunc)(RCP<const ParameterList>)=NULL);

  void getInputExtraOptions(
    RCP<ParameterList> validParameters,
    RCP<DependencySheet> dependencySheet=null,
    std::string styleSheetFilePath = "",
    std::string iconFilePath = "",
    void (*customFunc)(RCP<const ParameterList>)=NULL);

  void getInputExtraOptions(
    const std::string& nameOfXmlFile,
    RCP<ParameterList>& userInput,
    std::string styleSheetFilePath = "",
    std::string iconFilePath = "",
    void (*customFunc)(RCP<const ParameterList>)=NULL);



class OptikaGUI{
public:

  OptikaGUI(
    RCP<ParameterList> validParameters, 
    RCP<DependencySheet> dependencySheet=null,
    void (*customFunc)(RCP<const ParameterList>)=NULL);

  OptikaGUI(const std::string& xmlFileName,
    void (*customFunc)(RCP<const ParameterList>)=NULL);



  
  void exec();



  
  void setAboutInfo(const std::string& aboutInfo);

  void setActionButtonText(const std::string& text);

  void setWindowTitle(const std::string& title);

  void setWindowIcon(const std::string& filePath);

  void setStyleSheet(const std::string& filePath);

  void setCustomFunction(void (*customFunc)(RCP<const ParameterList>));

  std::string getWindowTitle();

  std::string getWindowIcon();

  std::string getStyleSheet();

  std::string getAboutInfo();


private:
  
  RCP<ParameterList> validParameters;

  RCP<DependencySheet> dependencySheet;

  std::string title;

  std::string iconFilePath;

  std::string styleSheetFilePath;

  std::string aboutInfo;

  std::string actionButtonText;

  void (*customFunc)(RCP<const ParameterList>);

};

}

#endif //OPTIKA_GUI_HPP_