mgui/editbase.h

Go to the documentation of this file.

#ifndef  INC_MGUI_EDITBASE_H
#define  INC_MGUI_EDITBASE_H

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

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

namespace MGUI {

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

      enum CREATEFLAGS {
         CREATEFLAG_None =                0x00000000,
         CREATEFLAG_ReadOnly =            0x00010000, 
         CREATEFLAG_RightAlign =          0x00020000, 
         CREATEFLAG_Opaque =              0x00040000, 
         CREATEFLAG_UseFixedWidthFont =   0x00080000, 
         CREATEFLAG_WordWrap =            0x00100000, 
         CREATEFLAG_WidthInPixels =       0x00200000, 
         CREATEFLAG_HeightInPixels =      0x00400000, 
         CREATEFLAG_SizeInPixels =        (CREATEFLAG_WidthInPixels|CREATEFLAG_HeightInPixels),
         CREATEFLAG_MASK =                0xFFFF0000
         };

      CTRL_EDIT_BASE (
         );

      ~CTRL_EDIT_BASE (
         );

      void ClearSelection (
         );

      void CopySelection (
         );

      void CutSelection (
         );

      INT32 GetCursorPos (
         ) const;

      const bool GetModify (
         ) const { return (m_UserEdited); }

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

      void Insert (
         const MISTRING& text
         );

      bool HasValue (
         ) const;

      void Paste (
         );

      void ReplaceSelection (
         const MISTRING& NewText
         );

      void SetANSIColor (
         INT32 indx,
         const COLOR& color
         );

      void SetDelegateOnActivate (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnActivate = delegate; }

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

      void SetDelegateOnGainFocus (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnGainFocus = delegate; }

      void SetDelegateOnLoseFocus (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnLoseFocus = delegate; }

      void SetDelegateOnSelection (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnSelection = delegate; }

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

      void SetDisplayNoValue (
         const MISTRING& string
         );

      void SetMaxLength (
         int length
         );

      void SetModify (
         bool modified = true
         ) { m_UserEdited = modified; }

      void SetReadOnly (
         bool ReadOnly = true                
         );

      void SetSelection (
         int StartChar = 0,                  
         int EndChar = -1,                   
         bool NoScroll = true                
         );

      void SetValidChars (
         const MIUNICODE* string,               
         bool invert = false                 
         );

   protected:

      bool m_UserEdited;
      bool m_HasValue;

      bool CheckValidChars (
         MISTRING& string                       
         ) const;

      void CreateCtrl (
         LAYOUT_PANE_BASE& ParentPane,
         int width,                             
         int height,                            
         CREATEFLAGS flags,
         LAYOUT_SIZEALIGN sizealign
         );

      bool GetEditStr (
         MISTRING& str
         ) const;

      // Send value change notification via OnChangeValue.
      void NotifyChanged (
         ) { OnChangeValue(); }

      void UpdateCtrl (
         const MISTRING& string
         );

      void UpdateValue (bool notify);

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      DELEGATE_VOID_NOPARMS m_DelegateOnActivate;
      DELEGATE_VOID_NOPARMS m_DelegateOnChangeValue;
      DELEGATE_VOID_NOPARMS m_DelegateOnUserEdit;
      DELEGATE_VOID_NOPARMS m_DelegateOnSelection;
      DELEGATE_VOID_NOPARMS m_DelegateOnGainFocus;
      DELEGATE_VOID_NOPARMS m_DelegateOnLoseFocus;

      Widget m_TraversalWidget;
      int m_TraversalDir;
      int m_MaxLength;

      bool m_InternalModify;
      bool m_ValidInvert;
      MISTRING m_ValidChars;
      MISTRING m_EmptyDisplay;

      static void CB_Activate (Widget, CTRL_EDIT_BASE*, void*);
      static void CB_Focus (Widget, CTRL_EDIT_BASE*, void*);
      static void CB_LosingFocus (Widget, CTRL_EDIT_BASE*, void*);
      static void CB_ModifyVerify (Widget, CTRL_EDIT_BASE*, void*);
      static void CB_ValueChanged (Widget, CTRL_EDIT_BASE*, void*);
      static void CB_Selection (Widget, CTRL_EDIT_BASE*, void*);

      void OnUserEdit ();

      CTRL_EDIT_BASE (const CTRL_EDIT_BASE&);
      CTRL_EDIT_BASE& operator= (const CTRL_EDIT_BASE&);
      #endif // GENERATING_DOXYGEN_OUTPUT

      // CTRL_EDIT_BASE Overridables

      virtual void OnActivate ();

      virtual void OnChangeValue ();

      virtual void v_OnUserEdit ();

      virtual void v_UpdateValue (
         MISTRING& newvalue
         );

   };
#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(CTRL_EDIT_BASE::CREATEFLAGS)
#endif

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

}  // End namespace MGUI

#endif   // INC_MGUI_EDITBASE_H

---