mgui/wysiwyg.h

Go to the documentation of this file.

#ifndef  INC_MGUI_WYSIWYG_H
#define  INC_MGUI_WYSIWYG_H

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

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


#ifndef GENERATING_DOXYGEN_OUTPUT
struct TEXTSTYLE;
#endif


namespace MGUI {

//===================================================================================================================
class CTRL_EDIT_TEXT_WYSIWYG : public MGUI::CTRL {
   public:

      enum FLAGS {
         FLAG_Default =       0x0000,
         FLAG_ReadOnly =      0x0001,     
         };

      CTRL_EDIT_TEXT_WYSIWYG (
         );

      virtual ~CTRL_EDIT_TEXT_WYSIWYG (
         );

      bool CanUndo (
         ) const;
         ;

      void ClearValue (
         bool notify = true                  
         );

      void ClearSelection (
         );

      void CutSelection (
         );

      void CopySelection (
         );

      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane, 
         int width = 0,                      
         int height = 0,                     
         FLAGS flags = FLAG_Default,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedHeight
         );

      INT32 GetCursorPos (
         ) const;

      int GetFirstVisibleLine (
         ) const;

      int GetLineCount (
         ) const;

      int GetLineFromChar (
         int nIndex = -1
         ) const;

      int GetLineIndex (
         int nLine = -1
         );

      int GetLineLength (
         int nLine = -1
         );

      bool GetModify (
         ) const;
         ;

      void GetSelection (
         int& nStartChar,     
         int& nEndChar        
         ) const;

      void GetStyle (
         TEXTSTYLE& style,
         int offset = -1      
         ) const;

      const MISTRING& GetValue (
         ) const { return (m_value); }

      bool GetWYSIWYG (
         ) const;

      void HideCursor (
         );

      void LineScroll (
         int nLines,       
         int nChars = 0    
         );

      void Paste ();

      void SetCursorPos (
         int nCharIndex,
         bool bScroll = true  
         );

      void SetCursorPos (
         int line,
         int col,
         bool bScroll = true  
         );

      void SetDelegateOnChangeValue (
         DELEGATE_VOID_NOPARMS Delegate
         ) { m_DelegateOnChangeValue = Delegate; }

      void SetDelegateOnCursorMotion (
         DELEGATE_BOOL_INT32 Delegate
         ) { m_DelegateOnCursorMotion = Delegate; }

      void SetDelegateOnFocus (
         DELEGATE_VOID_NOPARMS Delegate
         ) { m_DelegateOnFocus = Delegate; }

      void SetDelegateOnLosingFocus (
         DELEGATE_VOID_NOPARMS Delegate
         ) { m_DelegateOnLosingFocus = Delegate; }

      void SetDelegateOnToggleWYSIWYG (
         DELEGATE_VOID_BOOL Delegate
         ) { m_DelegateOnToggleWYSIWYG = Delegate; }

      void SetDelegateOnUserEdit (
         DELEGATE_VOID_NOPARMS Delegate
         ) { m_DelegateOnUserEdit = Delegate; }

      void SetModify (
         bool modified = true
         );

      void SetReadOnly (
         bool ReadOnly = true                
         );

      void SetSelection (
         int start,
         int end
         );

      void SetStyle (
         const TEXTSTYLE& style
         );

      void SetStyle (
         const TEXTSTYLE& style,
         int start,           
         int end              
         );

      void SetValue (
         const MIUNICODE* string,               
         bool notify = true                  
         );

      void SetWordWrap (
         bool bWordWrap = true
         );

      void SetWYSIWYG (
         bool bvalue
         );

      void ShowCursor (
         );

      void Undo ();

   protected:

      virtual void v_OnActivate ();

      virtual void v_OnChangeValue ();

      virtual void v_OnUserEdit ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      bool m_UserEdited;
      Widget m_TraversalWidget;
      int m_TraversalDir;
      bool m_InternalModify;
      bool m_HasValue;
      MISTRING m_value;
      DELEGATE_VOID_NOPARMS m_DelegateOnChangeValue;
      DELEGATE_BOOL_INT32 m_DelegateOnCursorMotion;
      DELEGATE_VOID_NOPARMS m_DelegateOnFocus;
      DELEGATE_VOID_NOPARMS m_DelegateOnLosingFocus;
      DELEGATE_VOID_NOPARMS m_DelegateOnUserEdit;
      DELEGATE_VOID_BOOL m_DelegateOnToggleWYSIWYG;

      virtual void v_SetFocus() const;

      bool GetEditStr (MISTRING& str) const;
      void UpdateCtrl (const MISTRING& string);

      virtual void UpdateValue (bool notify = true);

      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*);
      static void CB_MotionVerify (Widget, CTRL_EDIT_TEXT_WYSIWYG*, void*);
      static void CB_ToggleWYSIWYG (Widget, CTRL_EDIT_TEXT_WYSIWYG*, void*);

      // Unimplemented
      CTRL_EDIT_TEXT_WYSIWYG (const CTRL_EDIT_TEXT_WYSIWYG&);
      CTRL_EDIT_TEXT_WYSIWYG& operator= (const CTRL_EDIT_TEXT_WYSIWYG&);

      #endif   // GENERATING_DOXYGEN_OUTPUT
   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(MGUI::CTRL_EDIT_TEXT_WYSIWYG::FLAGS)
#endif


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

}  // End of MGUI namespace

#endif   // INC_MGUI_CTRL_H

---