formrcmp.h

Go to the documentation of this file.

/**
 * \file mgui/formrcmp.h
 * \brief MGUI::FORM_RASTER_COMPRESSION class definitions
 *
 * \if NODOC
 * $Id: formrcmp.h_v 1.10 2003/11/24 15:19:16 mju Exp $
 *
 * $Log: formrcmp.h_v $
 * Revision 1.10  2003/11/24 15:19:16  mju
 * Change default for SetCompression quality/ratio to 0 for max/lossless.
 *
 * Revision 1.9  2003/11/24 15:11:03  mju
 * Add SetFromMakeParms.
 *
 * Revision 1.8  2003/11/24 14:59:20  mju
 * Redesign to -
 *   not use MAKEPARMS
 *   use formstyle flags for NoLossy, NoReadOnly.
 *
 * Revision 1.7  2003/10/30 21:51:23  scowan
 * Added flags parameter.
 *
 * Revision 1.6  2003/10/22 22:26:06  scowan
 * Added correct jp2K items to dialog.
 *
 * Revision 1.5  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.4  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.3  2003/09/05 14:01:45  scowan
 * Added jp2000 selection
 *
 * Revision 1.2  2003/03/05 17:09:37  scowan
 * Chagned default size alignment.
 *
 * Revision 1.1  2003/03/04 22:53:58  scowan
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MGUI_FORMRCMP_H
#define  INC_MGUI_FORMRCMP_H

#ifndef  INC_MGUI_COMBOBOX_H
#include <mgui/combobox.h>
#endif

#ifndef  INC_RVC_RASTER_H
#include <rvc/raster.h>
#endif

namespace MGUI {

//! Form for setting raster internal compression type and quality.
class FORM_RASTER_COMPRESSION : public MGUI::FORM_COMPOSITE {
   public:

      //! Form style enumeration.   
      enum FORMSTYLE {
         FORMSTYLE_Default =     0x00,
         FORMSTYLE_NoLossy =     0x01,    //!< Don't allow lossy compression choices
         FORMSTYLE_NoReadOnly =  0x02     //!< Don't allow compression which does not support overwrite
         };
   
      //! Constructor.
      //! Defaults to a celltype of RVC::IMAGE::CELLTYPE_Unsigned_8 for menu generation purposes
      FORM_RASTER_COMPRESSION (
         );

      //! Destructor.
      virtual ~FORM_RASTER_COMPRESSION (
         );
         
      //! Create the form.
      ERRVALUE Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,          //!< Parent pane
         FORMSTYLE Style = FORMSTYLE_Default,         //!< Form style
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedHeight
         );

      //! Get currently selected compression quality/ratio.
      //! @return Compression quality/ratio.
      UINT16 GetCompressionQualityRatio (
         );

      //! Get currently selected compression type.
      RVC::RASTER::COMPTYPE GetCompressionType (
         ) const;

      //! Determine if lossy compression type is selected.
      bool IsLossy (
         ) const;

      //! Set cell type for limiting compression choices.
      //! If current compression type not allowed for specified CELLTYPE
      //! the selection will be reset to 'uncompressed'.
      //! Create() must be called before using this method.
      void SetCellType (
         RVC::IMAGE::CELLTYPE CellType
         );

      //! Set selected compression parameters.
      //! If specified values are not allowed for current CELLTYPE the
      //! selection will be left unchanged.
      //! Create() must be called before using this method.
      void SetCompression (
         RVC::RASTER::COMPTYPE CompType,              //!< Compression type
         UINT16 CompQualityRatio = 0                  //!< Compression quality or ratio, 0 for maximum quality/lossless
         );

      //! Set cell type and compression selection from RASTER::MAKEPARMS.
      void SetFromMakeParms (
         const RVC::RASTER::MAKEPARMS& MakeParms
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      FORMSTYLE m_FormStyle;
      RVC::IMAGE::CELLTYPE m_CellType;
      MGUI::FORM_COMBOBOX_T<FORM_RASTER_COMPRESSION> m_ComboType;
      MGUI::FORM_EDIT_NUMBER m_EditQuality;
      MGUI::FORM_EDIT_NUMBER m_EditRatio;

      void OnComboType ();
      #endif // GENERATING_DOXYGEN_OUTPUT

   };
   
DEFINE_ENUM_OP_BITWISE(FORM_RASTER_COMPRESSION::FORMSTYLE)

}     //End of MGUI namespace


#endif      // INC_MGUI_FORMRCMP_H

---