mgui/dlggetobjectfilter.h

Go to the documentation of this file.

#ifndef  INC_MGUI_DLGGETOBJECTFILTER_H
#define  INC_MGUI_DLGGETOBJECTFILTER_H

#ifndef  INC_MI32_DELEGATEFILTER_H
#include <mi32/delegatefilter.h>
#endif

#ifndef  INC_MI32_MISTRING_H
#include <mi32/mistring.h>
#endif

#ifndef  INC_MI32_MILIST_H
#include <mi32/milist.h>
#endif

#ifndef  INC_RVC_OBJTYPESET_H
#include <rvc/otypeset.h>
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
class FILEPATH;
class FILETYPE;
class FILETYPESET;
namespace RVC {
   class OBJITEM;
   class OBJITEMLIST;
   }
#endif

namespace MGUI {

//=====================================================================================================================

class DLG_GETOBJECT_FILTER {
   public:

      DLG_GETOBJECT_FILTER (
         );

      DLG_GETOBJECT_FILTER (
         const char *extns             
         );

      DLG_GETOBJECT_FILTER (
         const MISTRING& extns         
         );

      DLG_GETOBJECT_FILTER (
         const RVC::OBJTYPESET& ObjTypeSetSelectable
         );

      DLG_GETOBJECT_FILTER (
         const RVC::OBJTYPESET& ObjTypeSetSelectable,
         const RVC::OBJTYPESET& ObjTypeSetValidParent
         );

      // Destructor.
      virtual ~DLG_GETOBJECT_FILTER ();

      void AddDelegateIsFileSelectable (
         DELEGATE_FILTER_FILEPATH delegate
         );

      void AddDelegateIsFolderBrowsable (
         DELEGATE_FILTER_FILEPATH delegate
         );

      void AddDelegateIsFolderSelectable (
         DELEGATE_FILTER_FILEPATH delegate
         );

      void AddDelegateIsFolderValidParent (
         DELEGATE_FILTER_FILEPATH delegate
         );

      void AddDelegateIsListValid (
         DELEGATE_FILTER_OBJITEMLIST delegate
         );

      void AddDelegateIsObjectBrowsable (
         DELEGATE_FILTER_OBJITEM delegate
         );

      void AddDelegateIsObjectSelectable (
         DELEGATE_FILTER_OBJITEM delegate,
         bool inclusive = true               
         );

      void AddDelegateIsObjectValidParent (
         DELEGATE_FILTER_OBJITEM delegate
         );

      void AddFileType (
         const FILETYPE& filetype                  
         );

      void AddFileTypes (
         const char *extn                          
         );

      void AddFileTypes (
         const MISTRING& extn                      
         );

      void AddObjTypeSelectable (
         RVC::OBJTYPE ObjTypeSelectable
         );

      void AddObjTypeSetSelectable (
         const RVC::OBJTYPESET& ObjTypeSetSelectable
         );

      void Clear (
         ) const { m_Message.Clear(); m_ErrValue = 0; }

      bool GetAllowAllFileExtns (
         ) const { return (m_AllowAllFileExtns); }

      bool GetAllowAllObjTypes (
         ) const { return (m_AllowAllObjTypes); }

      ERRVALUE GetErrValue (
         ) const { return (m_ErrValue); }

      const FILETYPESET& GetFileTypeSet (
         ) const { return (*m_pFileTypeSet); }
         
      MISTRING GetMessage (
         TEXTID TextID = TEXTID__None     
         ) const;

      const RVC::OBJTYPESET& GetObjTypeSetSelectable (
         ) const { return (m_ObjTypeSetSelectable); }
         
      const RVC::OBJTYPESET& GetObjTypeSetValidParent (
         ) const { return (m_ObjTypeSetValidParent); }
         
      bool IsFileSelectable (
         const FILEPATH& filepath,                    
         int position = -1,                           
         DLG_GETOBJECT_FILTER *pFilterProxyFor = 0    
         ) const;

      bool IsFolderBrowsable (
         const FILEPATH& filepath,                    
         DLG_GETOBJECT_FILTER *pFilterProxyFor = 0    
         ) const;

      bool IsFolderSelectable (
         const FILEPATH& filepath,                    
         int position = -1,                           
         DLG_GETOBJECT_FILTER *pFilterProxyFor = 0    
         ) const;

      bool IsFolderValidParent (
         const FILEPATH& filepath,                    
         DLG_GETOBJECT_FILTER *pFilterProxyFor = 0    
         ) const;

      bool IsListValid (
         const RVC::OBJITEMLIST& objlist,             
         DLG_GETOBJECT_FILTER *pFilterProxyFor = 0    
         ) const;

      bool IsObjectBrowsable (
         const RVC::OBJITEM& objitem,                 
         DLG_GETOBJECT_FILTER *pFilterProxyFor = 0    
         ) const;

      bool IsObjectSelectable (
         const RVC::OBJITEM& objitem,                 
         int position = -1,                           
         DLG_GETOBJECT_FILTER *pFilterProxyFor = 0,      
         bool bIgnoreDelegates = false             
         ) const;

      bool IsObjectValidParent (
         const RVC::OBJITEM& parent,                  
         DLG_GETOBJECT_FILTER *pFilterProxyFor = 0    
         ) const;

      void SetAllowAllFileExtns (
         bool allow = true
         ) { m_AllowAllFileExtns = allow; }

      void SetAllowBrowseIfHasSelectableChild (
         bool allow = true
         ) const { m_AllowBrowseIfHasSelectableChild = allow; }

      void SetErrValue (
         ERRVALUE err
         ) const { m_ErrValue = err; }
         
      void SetMessage (
         const MISTRING& message
         ) const { m_Message = message; }
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      typedef MILIST<DELEGATE_FILTER_FILEPATH> DELEGATELIST_FILE;
      typedef MILIST<DELEGATE_FILTER_OBJITEMLIST> DELEGATELIST_LIST;
      typedef MILIST<DELEGATE_FILTER_OBJITEM> DELEGATELIST_OBJECT;

      RVC::OBJTYPESET m_ObjTypeSetSelectable;
      mutable RVC::OBJTYPESET m_ObjTypeSetValidParent;
      DELEGATELIST_FILE m_DelegateListIsFileSelectable;
      DELEGATELIST_FILE m_DelegateListIsFolderBrowsable;
      DELEGATELIST_FILE m_DelegateListIsFolderSelectable;
      DELEGATELIST_FILE m_DelegateListIsFolderValidParent;
      DELEGATELIST_OBJECT m_DelegateListIsObjectBrowsable;
      DELEGATELIST_OBJECT m_DelegateListIsObjectSelectableExclusive;
      DELEGATELIST_OBJECT m_DelegateListIsObjectSelectableInclusive;
      DELEGATELIST_OBJECT m_DelegateListIsObjectValidParent;
      DELEGATELIST_LIST m_DelegateListIsListValid;
      FILETYPESET *m_pFileTypeSet;
      bool m_AllowAllFileExtns;
      bool m_AllowAllObjTypes;
      mutable bool m_AllowBrowseIfHasSelectableChild;
      bool m_AllowBrowseIfIsValidParent;
      mutable bool m_NeedUpdateValidParentSet;
      mutable MISTRING m_Message;
      mutable ERRVALUE m_ErrValue;

      void AddFileExtn (const MISTRING& extn);
      void UpdateValidParentSet () const;
      #endif // GENERATING_DOXYGEN_OUTPUT

      virtual bool v_IsFileSelectable (
         const FILEPATH& filepath,        
         int position                     
         ) const;

      virtual bool v_IsFolderBrowsable (
         const FILEPATH& filepath         
         ) const;

      virtual bool v_IsFolderSelectable (
         const FILEPATH& filepath,        
         int position                     
         ) const;

      virtual bool v_IsFolderValidParent (
         const FILEPATH& filepath         
         ) const;

      virtual bool v_IsListValid (
         const RVC::OBJITEMLIST& objlist
         ) const;

      virtual bool v_IsObjectBrowsable (
         const RVC::OBJITEM& objitem      
         ) const;

      virtual bool v_IsObjectSelectable (
         const RVC::OBJITEM& objitem,     
         int position                     
         ) const;

      virtual bool v_IsObjectValidParent (
         const RVC::OBJITEM& parent
         ) const;

   };

//=====================================================================================================================

}  // End namespace MGUI

#endif   // INC_MGUI_DLGGETOBJECTFILTER_H

---