getobjf.h

Go to the documentation of this file.

/**
 * \file rvc/getobjf.h 
 * \brief RVC::GETOBJFILTER class definitions
 *
 * \if NODOC
 * $Id: getobjf.h_v 1.5 2003/10/08 22:21:05 scowan Exp $
 *
 * $Log: getobjf.h_v $
 * Revision 1.5  2003/10/08 22:21:05  scowan
 * Doxygen adjustments.
 *
 * Revision 1.4  2003/09/30 16:52:06  dwilliss
 * Doxygen
 *
 * Revision 1.3  2003/09/25 21:56:37  dwilliss
 * doxygen
 *
 * Revision 1.2  2003/09/15 13:49:45  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.1  2002/09/09 20:05:37  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_RVC_GETOBJF_H
#define  INC_RVC_GETOBJF_H

#ifndef  INC_MI32_RVCDEFNS_H
#include <mi32/rvcdefns.h>
#endif

namespace RVC {

//===================================================================================================================
//! \class GETOBJFILTER rvc/getobjf.h
//! \brief Base class for object selection filter.
//! If a filter is provided to the DlgGetObject... function the IsSelectable() method
//! will be called when the user attempts to select an object.  In addition, for the
//! DlgGetObjects() and DlgGetObjectSet() functions, the IsValidList() method will be
//! called when the user presses the 'OK' button.  This allows the list to be checked
//! for self-consistency (for example, to make sure all rasters have equal dimensions).
class GETOBJFILTER {
   public:

      //! Default constructor.
      GETOBJFILTER (
         );

      //! Clear current TEXTID and error value settings.
      void Clear (
         ) { m_TextID = TEXTID__None; m_ErrValue = 0; }

      //! Get current error value.
      ERRVALUE GetErrValue (
         ) const { return (m_ErrValue); }
         
      //! Get message based on the stored TEXTID and error value.
      //! If both and error value and a TEXTID are set the error value will take precedence.
      MISTRING GetMessage (
         TEXTID TextID = TEXTID__None     //!< Text ID to use for message if none previously set
         ) const;
         
      //! Get current TEXTID setting.
      TEXTID GetTextID (
         ) const { return (m_TextID); }
         
      //! Determine if has selectable subobjects.
      //! Calls v_HasSelectableSubObjects which can be overridden.
      bool HasSelectableSubObjects (
         const RVC::OBJITEM& objitem      //!< Object to check
         ) { Clear(); return (v_HasSelectableSubObjects(objitem)); }

      //! Determine if object is selectable.
      //! @return 'true' if selectable, 'false' if not.
      //! Calls v_IsSelectable() which can be overridden.
      bool IsSelectable (
         const RVC::OBJITEM& objitem,     //!< Object to check
         int position = -1                //!< Position of the object in the set for DlgGetObjectSet() functions.
         ) { Clear(); return (v_IsSelectable(objitem,position)); }

      //! Determine if list of objects is valid and usable together.
      //! @return 'true' if list is valid, 'false' if not.
      //! Calls v_IsValidList which can be overridden.
      bool IsValidList (
         const RVC::OBJITEMLIST& objlist  //!< Object list to check
         ) { Clear(); return (v_IsValidList(objlist)); }

      //! Set error value.
      void SetErrValue (
         ERRVALUE err
         ) { m_ErrValue = err; }
         
      //! Set the current TEXTID for this filter
      void SetTextID (
         TEXTID TextID
         ) { m_TextID = TextID; }
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      TEXTID m_TextID;
      ERRVALUE m_ErrValue;
      #endif // GENERATING_DOXYGEN_OUTPUT

      //! Called by HasSelectableSubObjects() to determine if has selectable subobjects.
      //! Default implementation always returns 'false'.
      virtual bool v_HasSelectableSubObjects (
         const RVC::OBJITEM& objitem      //!< Object to check
         );

      //! Called by IsSelectable() to determine if object is selectable.
      //! @return 'true' if selectable, 'false' if not.
      //! Default implementation always returns 'true'.
      virtual bool v_IsSelectable (
         const RVC::OBJITEM& objitem,     //!< Object to check
         int position                     //!< Position of the object in the set for DlgGetObjectSet() functions.
         );

      //! Called by IsValidList() to determine if list of objects is valid and usable together.
      //! @return 'true' if list is valid, 'false' if not.
      //! Default implementation always returns 'true'.
      virtual bool v_IsValidList (
         const RVC::OBJITEMLIST& objlist
         );

   };


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

}  //! End namespace RVC

#endif   //!< INC_RVC_GETOBJF_H

---