FileDialog.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/FileDialog.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All 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 names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "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 PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) 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.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_FileDialog_h
#define __PCL_FileDialog_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/File.h>
#include <pcl/StringList.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class FileDialogPrivate;
class OpenFileDialogPrivate;
class SaveFileDialogPrivate;
class GetDirectoryDialogPrivate;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS FileFilter
{
public:
 
   FileFilter() = default;
 
   FileFilter( const String& description, const StringList extensions )
   {
      SetDescription( description );
      AddExtensions( extensions );
   }
 
   FileFilter( const String& description, const String& extension )
   {
      SetDescription( description );
      AddExtension( extension );
   }
 
   FileFilter( const FileFilter& x ) = default;
 
   virtual ~FileFilter()
   {
   }
 
   String Description() const
   {
      return m_description;
   }
 
   void SetDescription( const String& description )
   {
      m_description = description.Trimmed();
   }
 
   const StringList& Extensions() const
   {
      return m_extensions;
   }
 
   void AddExtension( const String& extension );
 
   void AddExtensions( const StringList& extensions )
   {
      for ( const String& extension : extensions )
         AddExtension( extension );
   }
 
   void Clear();
 
private:
 
   String      m_description;
   StringList  m_extensions;
 
   String MakeAPIFilter() const;
 
   friend class FileDialogPrivate;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS FileDialog
{
public:
 
   using filter_list = Array<FileFilter>;
 
   FileDialog();
 
   virtual ~FileDialog();
 
   String Caption() const;
 
   void SetCaption( const String& caption );
 
   String InitialPath() const;
 
   void SetInitialPath( const String& path );
 
   const filter_list& Filters() const;
 
   void SetFilters( const filter_list& filters );
 
   void SetFilter( const FileFilter& filter )
   {
      SetFilters( filter_list() << filter );
   }
 
   void AddFilters( const filter_list& filters );
 
   void AddFilter( const FileFilter& filter )
   {
      AddFilters( filter_list() << filter );
   }
 
   filter_list& Filters();
 
   String SelectedFileExtension() const;
 
   void SetSelectedFileExtension( const String& );
 
   virtual bool Execute() = 0;
 
protected:
 
   AutoPointer<FileDialogPrivate> p;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS OpenFileDialog : public FileDialog
{
public:
 
   OpenFileDialog();
 
   ~OpenFileDialog() override;
 
   void LoadImageFilters();
 
   bool AllowsMultipleSelections() const;
 
   void EnableMultipleSelections( bool enable = true );
 
   void DisableMultipleSelections( bool disable = true )
   {
      EnableMultipleSelections( !disable );
   }
 
   bool Execute() override;
 
   const StringList& FileNames() const;
 
   String FileName() const;
 
private:
 
   AutoPointer<OpenFileDialogPrivate> q;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS SaveFileDialog : public FileDialog
{
public:
 
   SaveFileDialog();
 
   ~SaveFileDialog() override;
 
   void LoadImageFilters();
 
   bool IsOverwritePromptEnabled() const;
 
   void EnableOverwritePrompt( bool enable = true );
 
   void DisableOverwritePrompt( bool disable = true )
   {
      EnableOverwritePrompt( !disable );
   }
 
   bool Execute() override;
 
   String FileName() const;
 
private:
 
   AutoPointer<SaveFileDialogPrivate> q;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS GetDirectoryDialog : public FileDialog
{
public:
 
   GetDirectoryDialog();
 
   ~GetDirectoryDialog() override;
 
   bool Execute() override;
 
   String Directory() const;
 
private:
 
   AutoPointer<GetDirectoryDialogPrivate> q;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_FileDialog_h
 
// ----------------------------------------------------------------------------
// EOF pcl/FileDialog.h - Released 2024-06-18T15:48:54Z