rvc/getobjfilter.h

Go to the documentation of this file.

#ifndef  INC_RVC_GETOBJFILTER_H
#define  INC_RVC_GETOBJFILTER_H

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

namespace RVC {

class OBJITEM;
class OBJITEMLIST;

//===================================================================================================================
class GETOBJFILTER {
   public:

      GETOBJFILTER (
         );

      void Clear (
         ) { m_TextID = TEXTID__None; m_ErrValue = 0; }

      ERRVALUE GetErrValue (
         ) const { return (m_ErrValue); }
         
      MISTRING GetMessage (
         TEXTID TextID = TEXTID__None     
         ) const;
         
      TEXTID GetTextID (
         ) const { return (m_TextID); }
         
      bool HasSelectableSubObjects (
         const RVC::OBJITEM& objitem,        
         GETOBJFILTER *pFilterProxyFor = 0   
         );

      bool IsSelectable (
         const RVC::OBJITEM& objitem,        
         int position = -1,                  
         GETOBJFILTER *pFilterProxyFor = 0   
         );

      bool IsValidList (
         const RVC::OBJITEMLIST& objlist,    
         GETOBJFILTER *pFilterProxyFor = 0   
         );

      bool IsValidParent (
         const RVC::OBJITEM& parent,         
         GETOBJFILTER *pFilterProxyFor = 0   
         );

      void SetErrValue (
         ERRVALUE err
         ) { m_ErrValue = err; }
         
      void SetTextID (
         TEXTID TextID
         ) { m_TextID = TextID; }
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      TEXTID m_TextID;
      ERRVALUE m_ErrValue;
      #endif // GENERATING_DOXYGEN_OUTPUT

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

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

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

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

   };


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

}  // End namespace RVC

#endif   // INC_RVC_GETOBJFILTER_H

---