formedst.h

Go to the documentation of this file.

/**
 * \file rvc/formedst.h
 * \brief MGUI::FORM_EDITSTYLE class definitions
 *
 * \if NODOC
 * $Id: formedst.h_v 1.11 2004/04/08 21:18:34 mju Exp $
 *
 * $Log: formedst.h_v $
 * Revision 1.11  2004/04/08 21:18:34  mju
 * Make IsCreated public.
 *
 * Revision 1.10  2003/11/12 14:28:35  mju
 * Add ResetModified method.
 *
 * Revision 1.9  2003/09/25 21:56:37  dwilliss
 * doxygen
 *
 * Revision 1.8  2003/09/15 13:49:45  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.7  2003/07/29 21:20:35  dwilliss
 * Made SetEnabled public again.
 *
 * Revision 1.6  2003/03/10 21:49:31  mju
 * Remove parm from deletepattern.
 *
 * Revision 1.5  2003/01/31 18:47:49  mju
 * Remove unneeded styleopenmode member.
 *
 * Revision 1.4  2003/01/23 22:37:29  mju
 * Big redesign, move nested classes to implementation file.
 *
 * Revision 1.3  2003/01/06 15:54:22  mju
 * More functionality.
 *
 * Revision 1.2  2002/10/14 20:59:12  mju
 * Restructure so works in X.
 *
 * Revision 1.1  2002/08/13 21:57:04  mju
 * Initial revision
 *
 * 
 * 8     6/05/02 3:12p Mju
 * No vararg
 * 
 * 7     2/08/02 5:27p Dwilliss
 * Changed to use new CTRL_GRID
 * 
 * 6     12/13/01 10:55a Mju
 * MGUI unificiation with X.
 * 
 * 5     12/03/01 11:05a Mju
 * Remove references to old deprecated MGUI names.
 * 
 * 4     10/24/01 4:16p Mju
 * Use OnItemSelect instead of OnClickItem.
 * 
 * 3     10/24/01 12:04p Mju
 * Properly handle pattern deletion.
 * Show sample patterns and sort pattern lists.
 * Allow selection by single-click on item.
 * 
 * 2     10/10/01 9:49a Mju
 * 
 * 1     9/14/01 3:35p Mju
 * \endif
**/

#ifndef  INC_RVC_FORMEDST_H
#define  INC_RVC_FORMEDST_H

#ifndef  INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif

#ifndef  INC_MGUI_CTRL_H
#include <mgui/ctrl.h>
#endif

#ifndef  INC_MGUI_LISTITEM_H
#include <mgui/listitem.h>
#endif

#ifndef  INC_MGUI_FORMRBTN_H
#include <mgui/formrbtn.h>
#endif

#ifndef  INC_RVC_STYLE_H
#include <rvc/style.h>
#endif

#ifndef  INC_MI32_ELEMSTYL_H
#include <mi32/elemstyl.h>
#endif

#ifndef  INC_MGUI_IMAGELST_H
#include <mgui/imagelst.h>
#endif

namespace MGUI {

class CTRL_GRID;

class FORM_EDITSTYLE : public MGUI::FORM {
   public:

      //! Constructor.
      FORM_EDITSTYLE (
         );

      //! Destructor.
      virtual ~FORM_EDITSTYLE (
         );

      //! Commit changes made by user to file.
      ERRVALUE CommitChanges (
         );

      //! Create the form.
      ERRVALUE Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,
         RVC::STYLE::TYPE StyleType,
         RVC::EDITSTYLEFLAGS FormStyle = RVC::EDITSTYLEFLAG_None
         );

      //! Get active style number.
      //! @return Active style number, -1 for "default" style, < -1 if error.
      INT32 GetActiveStyleNum (
         ) const { return (GetActiveStyleNum(m_StyleType)); }

      //! Get active style number for specified type.
      //! @return Active style number, -1 for "default" style, < -1 if error.
      INT32 GetActiveStyleNum (
         RVC::STYLE::TYPE StyleType
         ) const;

      //! Get active style type.
      RVC::STYLE::TYPE GetActiveStyleType (
         ) const { return (m_StyleType); }

      //! Get current scale.
      double GetCurrentScale (
         ) { return (v_OnGetCurrentScale()); }

      //! Get default POINTSTYLE.
      void GetDefaultStyle (
         POINTSTYLE& PointStyle
         ) const;

      //! Get default LINESTYLE.
      void GetDefaultStyle (
         LINESTYLE& LineStyle
         ) const;

      //! Get default POLYSTYLE.
      void GetDefaultStyle (
         POLYSTYLE& PolyStyle
         ) const;

      //! Get default TEXTSTYLE.
      void GetDefaultStyle (
         TEXTSTYLE& TextStyle
         ) const;

      //! Get default MULTISTYLE.
      void GetDefaultStyle (
         MULTISTYLE& MultiStyle
         ) const;

      //! Get current style object item.
      void GetStyleObjItem (
         RVC::OBJITEM& ObjItem
         ) const { m_StyleObj.GetObjectItem(ObjItem); }

      virtual bool IsCreated () const;

      //! Determine if RVC style object has been modified by user edits.
      bool IsObjectModified (
         ) { CommitChanges(); return (m_ObjectModified); }

      //! Reset 'modified' status.
      void ResetModified (
         ) { m_ObjectModified = false; }

      //! Set active style number for specified style type.
      //! This does not change the style type being "edited", use SetStyleType() to do that.
      ERRVALUE SetActiveStyleNum (
         RVC::STYLE::TYPE StyleType,
         INT32 StyleNum
         );

      //! Set current 'map scale' for style samples and 'Current Scale' button.
      void SetCurrentMapScale (
         double CurMapScale
         ) { m_CurMapScale = CurMapScale; }

      //! Set default LINE style.
      void SetDefaultStyle (
         const LINESTYLE& LineStyle
         );

      //! Set default POINT style.
      void SetDefaultStyle (
         const POINTSTYLE& PointStyle
         );

      //! Set default POLYGON style.
      void SetDefaultStyle (
         const POLYSTYLE& PolygonStyle
         );

      //! Set default TEXT style.
      void SetDefaultStyle (
         const TEXTSTYLE& TextStyle
         );

      //! Set default MULTISTYLE style.
      void SetDefaultStyle (
         const MULTISTYLE& MultiStyle
         );

      //! MGUI::FORM overrides.
      virtual void SetEnabled (bool enabled = true);

      //! Set hardcopy pixel spacing in "pixels per inch".
      //! This value is used when user chooses units to view style elements in.
      void SetHardcopyDPI (
         double HardcopyDPI
         );

      //! Set style object to edit or select styles from.
      ERRVALUE SetStyleObject (
         const RVC::OBJITEM& ObjItem,
         RVC::OBJECT::OPENMODE OpenMode = RVC::OBJECT::OPENMODE_Read
         );

      //! Set type of style being edited.
      void SetStyleType (
         RVC::STYLE::TYPE StyleType
         );

   protected:

      void NotifyModified () { v_OnNotifyModified(); }

      void SetObjectModified (
         bool ObjectModified = true
         ) { m_ObjectModified = ObjectModified; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      class FORM_STYLES;
      friend class FORM_STYLES;
      class FORM_TYPE;
      friend class FORM_TYPE;
      class FORM_POINT;
      friend class FORM_POINT;
      class FORM_LINE;
      friend class FORM_LINE;
      class FORM_POLYGON;
      friend class FORM_POLYGON;
      class FORM_TEXT;
      friend class FORM_TEXT;

      //! Self-initializing members.
      LAYOUT_PANE m_FormPane;
      RVC::STYLE m_StyleObj;
      LISTITEMDEF m_ComboItemScaleAt[4];
      FORM_RADIOBUTTONS_T<FORM_EDITSTYLE> m_StyleTypeRB;
      CTRL_EDIT_STRING_T<FORM_EDITSTYLE> m_SampleStrES;
      IMAGELIST m_IconImageList;

      //! Explicitly initialized.
      RVC::EDITSTYLEFLAGS m_FormStyleFlags;
      MDLGPARENT m_dlgparent;
      bool m_ObjectModified;
      UINT32 m_NoDrawSample;
      double m_HardcopyDPI;
      double m_CurMapScale;
      RVC::STYLE::TYPE m_StyleType;
      FORM_STYLES *m_pFormStyles;
      FORM_POINT *m_pFormPoint;
      FORM_LINE *m_pFormLine;
      FORM_POLYGON *m_pFormPolygon;
      FORM_TEXT *m_pFormText;
      FORM_TYPE *m_pFormType[RVC::STYLE::TYPE_NumTypes];
      int m_IconIdxCheckBoxEmpty;
      int m_IconIdxCheckBoxBlack;
      int m_IconIdxCheckBoxGray;

      ERRVALUE ChangeStyleObject ();
      bool DeletePattern (RVC::STYLE::PATTERN PatternType, INT32 PatternNum);
      void EnableControls ();
      MDLGPARENT GetDlgParent () const { return (m_dlgparent); }
      double GetSizeUnitScale (int units) const;
      bool HasDftStyle () const { return (HasDftStyle(m_StyleType)); }
      bool HasDftStyle (RVC::STYLE::TYPE StyleType) const;
      bool HasStyle (RVC::STYLE::TYPE StyleType) const;
      bool InsertPatterns (RVC::STYLE::PATTERN PatternType, INT32 PatternNum, const COLOR& varcolor);
      void InvalidateSample ();
      bool IsObjectWritable () const { return (m_StyleObj.IsWritable()); }
      ERRVALUE LoadStyle ();
      void OnEditSampleStr ();
      void OnRadioStyleType ();
      void ResetStyleNums ();
      void RedrawStylesList ();
      INT32 SaveNewStyle (const RVC::OBJECTNAME& NewStyleName);

      //! MGUI::FORM overrides.
      virtual bool IsEnabled () const;
      virtual void SetVisible (bool visible = true);

      FORM_EDITSTYLE (const FORM_EDITSTYLE&);
      FORM_EDITSTYLE& operator= (const FORM_EDITSTYLE&);

      #endif // GENERATING_DOXYGEN_OUTPUT

      // FORM_EDITSTYLE overridables.

      //! Called to obtain "current" map scale.
      //! Default implementation returns -1.
      virtual double v_OnGetCurrentScale (
         );

      //! Method to obtain style description.
      //! Override to provide own descriptions.
      virtual void v_OnGetStyleDescription (
         RVC::STYLE::TYPE StyleType,
         INT32 StyleNum,
         MISTRING& desc
         );

      //! Called when modification made to current style.
      virtual void v_OnNotifyModified (
         );

   };

}  //! End of MGUI namespace


#endif   //!< INC_RVC_FORMEDST_H

---