mgui/wysiwyg.h

Go to the documentation of this file.

/** 
 * \file mgui/wysiwyg.h
 * \brief Definitions for MGUI::CTRL_EDIT_TEXT_WYSIWYG classes.
 *
 * WYSIWYG = What You See Is What You Get
 *
 * \if NODOC
 * $Id: wysiwyg.h_v 1.6 2003/10/03 19:58:19 linux32build!build Exp $
 *
 * $Log: wysiwyg.h_v $
 * Revision 1.6  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.5  2003/10/01 22:36:11  dwilliss
 * *** empty log message ***
 *
 * Revision 1.4  2003/10/01 22:32:41  dwilliss
 * doxygen
 *
 * Revision 1.3  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.2  2003/04/09 20:52:21  dwilliss
 * Don't use _T in templates.  MAc's ctype.h defines a global _T
 *
 * Revision 1.1  2002/10/09 22:26:51  dwilliss
 * Initial revision
 *
 * \endif
 **/

#ifndef  INC_MGUI_WYSIWYG_H
#define  INC_MGUI_WYSIWYG_H

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

#ifndef  INC_MI32_SIMPLEAR_H
#include <mi32/simplear.h>
#endif

struct TEXTSTYLE;

namespace MGUI {


//===================================================================================================================
//! Multi-line text 'edit' control.
class CTRL_EDIT_TEXT_WYSIWYG : public MGUI::CTRL {
   public:

      enum FLAGS {
         FLAG_Default =       0x0000,
         FLAG_ReadOnly =      0x0001,     //!< User cannot change value
         };

      //! Constructor.
      CTRL_EDIT_TEXT_WYSIWYG (
         );

      //! Destructor.
      virtual ~CTRL_EDIT_TEXT_WYSIWYG (
         );

      //! Determine if the last edit operation can be undone by a call to the Undo member function.
      bool CanUndo (
         ) const
      #ifdef WIN32_MFC
         { return (m_ctrl.CanUndo() != FALSE); }
      #endif
         ;

      //! Clear entire control to empty string.
      void ClearValue (
         bool notify = true                  //!< Call OnChangeValue() if control has already been created
         );

      //! Clear the current selection
      void ClearSelection (
         )
      #ifdef WIN32_MFC
         { m_ctrl.Clear(); }
      #endif
         ;

      //! Cut the current selection to the clipboard
      void CutSelection (
         )
      #ifdef WIN32_MFC
         { m_ctrl.Cut(); }
      #endif
         ;

      //! Copy the current selection to the clipboard
      void CopySelection (
         )
      #ifdef WIN32_MFC
         { m_ctrl.Copy(); }
      #endif
         ;

      //! Create control.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane, //!< Parent pane
         int width = 0,                      //!< Width in 'typical' characters, minimum if can expand based on sizealign
         int height = 0,                     //!< Height lines, minimum if can expand based on sizealign
         FLAGS flags = FLAG_Default,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedHeight
         );

   #ifdef WIN32_MFC
      //! Get reference to MFC control (MFC only).
      CRichEditCtrl& GetCtrl (
         ) { return (m_ctrl); }
   #endif

      //! Determines the topmost visible line in an edit control.
      //! Returns the zero-based index of the topmost visible line. For single-line edit controls, 
      //!   the return value is 0.
      int GetFirstVisibleLine (
         ) const
      #ifdef WIN32_MFC
         { return (m_ctrl.GetFirstVisibleLine()); }
      #endif
         ;

      //! Get the number of lines in the edit control.
      int GetLineCount (
         ) const
      #ifdef WIN32_MFC
         { return (m_ctrl.GetLineCount()); }
      #endif
         ;

      //! Retrieves the line number of the line that contains the specified character index.
      //! Returns the zero-based line number of the line containing the character index specified by nIndex. 
      //! If nIndex is -1, the number of the line that contains the first character of the selection 
      //! is returned. If there is no selection, the current line number is returned.
      int GetLineFromChar (
         int nIndex = -1
         ) const
      #ifdef WIN32_MFC
         { return (m_ctrl.LineFromChar(nIndex)); }
      #endif
         ;

      //! Retrieves the character index of a line within a multiple-line edit control.
      //! Returns the character index of the line specified in nLine or -1 if the specified line 
      //! number is greater then the number of lines in the edit control.
      int GetLineIndex (
         int nLine = -1
         )
      #ifdef WIN32_MFC
         { return (m_ctrl.LineIndex(nLine)); }
      #endif
         ;

      //! Retrieves the character index of a line within a multiple-line edit control.
      //! Return value is the length (in bytes) of the line specified by nLine.
      //! nLine specifies the character index of a character in the line whose length is to be 
      //! retrieved. If this parameter is -1, the length of the current line (the line that 
      //! contains the caret) is returned, not including the length of any selected text 
      //! within the line. 
      int GetLineLength (
         int nLine = -1
         )
      #ifdef WIN32_MFC
         { return (m_ctrl.LineLength(nLine)); }
      #endif
         ;

      //! Returns true if contents of the edit-control have been modified, false if not.
      //!   Use SetModify() to reset.
      const bool GetModify (
         ) const
      #ifdef WIN32_MFC
         { return (m_ctrl.GetModify() != FALSE); }
      #endif
         ;

      //! Get the current selection of the edit control.
      //!   If nStartChar == nEndChar, nothing is selected.
      void GetSelection (
         int& nStartChar,     //!< Receives the first character in the current selection
         int& nEndChar        //!< Receives the first non-selected character past the end of the current selection
         ) const
      #ifdef WIN32_MFC
         { m_ctrl.GetSel(nStartChar,nEndChar); }
      #endif
         ;

      //! Get the text style at the specified offset
      //! No effect unless created with the FLAG_WYSIWYG flag
      void GetStyle (
         TEXTSTYLE& style,
         int offset = -1      //!< Offset to get style at.  -1 for style at cursor
         ) const;

      //! Get current string value.
      const MISTRING& GetValue (
         ) const { return (m_value); }

      //! Hide the cursor (a.k.a. caret).
      void HideCursor (
         )
      #ifdef WIN32_MFC
         { m_ctrl.HideCaret(); }
      #endif
         ;

      //! Scrolls the text of a multiple-line edit control
      void LineScroll (
         int nLines,       //!< Specifies the number of lines to scroll vertically
         int nChars = 0    //!< Specifies the number of character positions to scroll horizontally
         )
      #ifdef WIN32_MFC
         { m_ctrl.LineScroll(nLines,nChars); }
      #endif
         ;

      //! Paste the clipboard contents at the current location
      void Paste (
         )
      #ifdef WIN32_MFC
         { m_ctrl.Paste(); }
      #endif
         ;

   #ifdef WIN32_MFC
      //! Called to process messages before translation.
      virtual bool PreTranslateMessageHook (
         MSG *pMsg
         );
   #endif

      //! Get the current cursor (a.k.a. caret) location.
      void SetCursorPos (
         int nCharIndex,
         bool bScroll = true  //!< True to scroll so cursor is visible in the window.
         );

      //! Get the current cursor (a.k.a. caret) location
      void SetCursorPos (
         int line,
         int col,
         bool bScroll = true  //!< True to scroll so cursor is visible in the window.
         )
      #ifdef WIN32_MFC
         { SetCursorPos(m_ctrl.LineIndex(line) + col, bScroll); }
      #endif
         ;

   #ifdef WIN32_MFC
      //! Set the font for the control (MFC only).
      void SetFont (
         const char* faceName,
         int pointSize     //!< in 10ths of a point
         ) {
         if (m_font.CreatePointFont(pointSize, faceName)) {
            m_ctrl.SetFont(&m_font);
            }
         }
   #endif

      //! Set or clear the "modified" state of the edit control.
      void SetModify (
         bool modified = true
         )
      #ifdef WIN32_MFC
         { m_ctrl.SetModify(modified); }
      #endif
         ;

      //! Set whether value is read-only or not.
      void SetReadOnly (
         bool ReadOnly = true                //!< True if read only, false if not
         ) {
      #ifdef WIN32_MFC
         m_ctrl.SetReadOnly(ReadOnly);
      #else
         MxSetTextEditable(m_widget,!ReadOnly);
      #endif
         }

      //! Select range of characters in string.
      void SetSelection (
         int StartChar = 0,                  //!< Starting character position in string, 0 for beginning
         int EndChar = -1,                   //!< Ending character position, -1 for end of string
         bool NoScroll = true                //!< Indicates whether to scroll caret into view
         )
      #ifdef WIN32_MFC
         { m_ctrl.SetSel(StartChar,EndChar,NoScroll); }
      #endif
         ;

      //! Get the text style of the current selection, or at the current
      //! cursor position (if nothing is selected)
      //! No effect unless created with the FLAG_WYSIWYG flag
      void SetStyle (
         const TEXTSTYLE& style
         );

      //! Get the text style of a range of text.
      //! No effect unless created with the FLAG_WYSIWYG flag
      void SetStyle (
         const TEXTSTYLE& style,
         int start,           //!< Starting offset to modify
         int end              //!< Ending offset to modify
         );

   #ifdef WIN32_MFC
      //! Set equal tab stops (MFC only);
      //! Call this function to set the tab stops in a multiple-line edit control. 
      //! When text is copied to a multiple-line edit control, any tab character in 
      //! the text will cause space to be generated up to the next tab stop.
      //!   The default is one tab stop every 32 dialog units.
      void SetTabStops (
         int cxEachStop    //!< tab stops are to be set at every cxEachStop dialog units 
         ) { m_ctrl.SetTabStops(cxEachStop); }
   #endif

   #ifdef WIN32_MFC
      //! Set variable tab stops.
      //! Call this function to set the tab stops in a multiple-line edit control. 
      //! When text is copied to a multiple-line edit control, any tab character in 
      //! the text will cause space to be generated up to the next tab stop.
      //!   The default is one tab stop every 32 dialog units.
      void SetTabStops (
         SIMPLE_ARRAY<int> stops //!< Array of stops
         ) { m_ctrl.SetTabStops(stops.GetNumItems(), stops); }
   #endif

      //! Set current string value with validation.
      //! OnValidate() will be called and if valid, the string will be updated.
      //! No comparison is made with the current string value.
      void SetValue (
         const UNICODE* string,              //!< New string to set
         bool notify = true                  //!< Call OnChangeValue() if string actually updated
         );

      //! Show the cursor (a.k.a. caret)
      void ShowCursor (
         )
      #ifdef WIN32_MFC
         { m_ctrl.ShowCaret(); }
      #endif
         ;

      //! Undo the last edit
      void Undo (
         )
      #ifdef WIN32_MFC
         { m_ctrl.Undo(); }
      #endif
         ;

   protected:

   #ifdef WIN32_MFC
      class MyEdit : public CRichEditCtrl {
         public:
            MyEdit (
               CTRL_EDIT_TEXT_WYSIWYG& guictrl
               ): m_guictrl(guictrl)
               { }
            virtual ~MyEdit (
               ) { }
            virtual BOOL PreCreateWindow (CREATESTRUCT& cs);
         protected:
            afx_msg void OnChange ();
            afx_msg void OnKillFocus ();
            DECLARE_MESSAGE_MAP()
         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            CTRL_EDIT_TEXT_WYSIWYG& m_guictrl;
            #endif // GENERATING_DOXYGEN_OUTPUT
         };
      friend class MyEdit;
      MyEdit m_ctrl;
   #endif

   #ifdef X_NATIVE
      bool m_UserEdited;
      Widget m_TraversalWidget;
      XmTraversalDirection m_TraversalDir;
      bool m_InternalModify;
   #endif
   #ifdef WIN32_MFC
      CFont m_font;
   #endif
      bool m_HasValue;
      MISTRING m_value;

      bool GetEditStr (
         MISTRING& str
         ) const;

      //! Called when user presses <Enter> in edit control.
      //! Derived class must call corresponding base class method BEFORE performing its own processing.
      virtual void OnActivate ();

      //! Called when value is changed after validation.
      //! Derived class must call corresponding base class method BEFORE performing its own processing.
      //! If the user modifies the text in the edit control this will not be called until the control loses "focus".
      virtual void OnChangeValue ();

      //! Called when user modifies the text in the edit control.
      //! Derived class must call corresponding base class method BEFORE performing its own processing.
      //! The actual value does not get updated until the control loses focus or GetValue() is called.
      virtual void OnUserEdit ();

      //! Called internally to update text control from specified string.
      void UpdateCtrl (
         const MISTRING& string
         );

      //! Called internally to update control-specific data from edit control.
      //! Derived class must call corresponding base class method AFTER performing its own processing.
      virtual void UpdateValue (bool notify = true);

   #ifdef X_NATIVE
      static void CB_Activate (Widget, CTRL_EDIT_TEXT_WYSIWYG*, void*);
      static void CB_Focus (Widget, CTRL_EDIT_TEXT_WYSIWYG*, void*);
      static void CB_LosingFocus (Widget, CTRL_EDIT_TEXT_WYSIWYG*, void*);
      static void CB_ModifyVerify (Widget, CTRL_EDIT_TEXT_WYSIWYG*, void*);
      static void CB_ValueChanged (Widget, CTRL_EDIT_TEXT_WYSIWYG*, void*);
   #endif

      //! Copy constructor and assignment operator are private and unimplemented
      CTRL_EDIT_TEXT_WYSIWYG (const CTRL_EDIT_TEXT_WYSIWYG&);
      CTRL_EDIT_TEXT_WYSIWYG& operator= (const CTRL_EDIT_TEXT_WYSIWYG&);
   };

DEFINE_ENUM_OPERATORS(MGUI::CTRL_EDIT_TEXT_WYSIWYG::FLAGS);


//-------------------------------------------------------------------------------------------------------------------
//! Convenience template for multiline text 'edit' control to allow method in container class to be called.
template <class _CT> class CTRL_EDIT_TEXT_WYSIWYG_T : public MGUI::CTRL_EDIT_TEXT_WYSIWYG {
   public:
      //! Constructor.
      explicit CTRL_EDIT_TEXT_WYSIWYG_T (
         _CT *pContainer = 0
         ): m_pContainer(pContainer), m_pfOnChangeValue(0)
         { }

      //! Set container pointer.
      //! Container may also be specified in constructor.
      void SetContainer (
         _CT *pContainer
         ) { m_pContainer = pContainer; }

      //! Set container method to call for OnChangeValue().
      void SetFuncChangeValue (
         void (_CT::*pfOnChangeValue)()
         ) { m_pfOnChangeValue = pfOnChangeValue; };

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      _CT *m_pContainer;
      void (_CT::*m_pfOnChangeValue)();

      virtual void OnChangeValue (
         ) {
         CTRL_EDIT_TEXT_WYSIWYG::OnChangeValue();
         if (m_pContainer != 0) (m_pContainer->*m_pfOnChangeValue)();
         }
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


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

}  // End of MGUI namespace

#endif   // INC_MGUI_CTRL_H

---