RFileDialog.hxx

Go to the documentation of this file.

// Author: Sergey Linev <S.Linev@gsi.de>
// Date: 2019-10-31
// Warning: This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!
 
/*************************************************************************
 * Copyright (C) 1995-2019, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
#ifndef ROOT7_RFileDialog
#define ROOT7_RFileDialog
 
#include <ROOT/RWebWindow.hxx>
#include <ROOT/RBrowserData.hxx>
 
#include <vector>
#include <memory>
#include <stdint.h>
 
namespace ROOT {
 
namespace Details {
   class RWebWindowPlugin;
}
 
/** \class ROOT::RFileDialog
\ingroup rbrowser
Initial message send to client to configure layout
*/
 
/// function signature for file dialog call-backs
/// argument is selected file name
using RFileDialogCallback_t = std::function<void(const std::string &)>;
 
 
/** Web-based FileDialog */
 
class RFileDialog {
   friend class Details::RWebWindowPlugin;
public:
 
   enum EDialogTypes {
      kOpenFile,
      kSaveAs,
      kNewFile
   };
 
protected:
 
   EDialogTypes fKind{kOpenFile};      ///<! dialog kind OpenFile, SaveAs, NewFile
   std::string fTitle;                 ///<! title, when not specified default will be used
   RBrowserData fBrowsable;            ///<! central browsing element
   bool fCanChangePath{true};          ///<! if working path can be changed via gui elements
 
   std::shared_ptr<RWebWindow> fWebWindow;   ///<! web window for file dialog
 
   bool fDidSelect{false};                ///<! true when dialog is selected or closed
   std::string fSelectedFilter;           ///<! name of selected filter
   std::vector<std::string> fNameFilters; ///<! name filters
   std::string fSelect;                   ///<! result of file selection
   RFileDialogCallback_t fCallback;       ///<! function receiving result, called once
 
   static std::string TypeAsString(EDialogTypes kind);
 
   void SendInitMsg(unsigned connid);
   void SendChPathMsg(unsigned connid);
 
   void ProcessMsg(unsigned connid, const std::string &arg);
 
   void InvokeCallBack();
 
   std::string GetRegexp(const std::string &name) const;
 
   static std::string Dialog(EDialogTypes kind, const std::string &title, const std::string &fname);
 
   static void SetStartFunc(bool on);
 
public:
 
   RFileDialog(EDialogTypes kind = kOpenFile, const std::string &title = "", const std::string &fname = "");
   virtual ~RFileDialog();
 
   const EDialogTypes &GetType() const { return fKind; }
 
   void SetCallback(RFileDialogCallback_t callback);
 
   /** Set array of name filters like "Text files (*.txt)", "Any files (*)", "Image files (*png *.jpg)"
    * Should be specified before starting dialog */
   void SetNameFilters(const std::vector<std::string> &arr) { fNameFilters = arr; }
   /** Returns array of name filters*/
   const auto &GetNameFilters() const { return fNameFilters; }
 
   /** Configure if working path in dialog can be changed via gui elements */
   void SetCanChangePath(bool on = true) { fCanChangePath = on; }
 
   /** Returns true if working path can be change with gui elements */
   bool GetCanChangePath() const { return fCanChangePath; }
 
   void SetWorkingPath(const std::string &);
   std::string GetWorkingPath() const;
 
   void SetSelectedFilter(const std::string &name);
   std::string GetSelectedFilter() const;
 
   void Show(const RWebDisplayArgs &args = "");
   void Hide();
 
   bool IsCompleted() const { return fDidSelect; }
   const std::string &GetFileName() const { return fSelect; }
 
   static std::string OpenFile(const std::string &title = "", const std::string &fname = "");
   static std::string SaveAs(const std::string &title = "", const std::string &fname = "");
   static std::string NewFile(const std::string &title = "", const std::string &fname = "");
 
   static std::shared_ptr<RFileDialog> Embed(const std::shared_ptr<RWebWindow> &window, unsigned connid, const std::string &args);
 
   static bool IsMessageToStartDialog(const std::string &msg);
 
};
 
} // namespace ROOT
 
#endif