formbtxt.h

Go to the documentation of this file.

/**
 * \file mgui/formbtxt.h
 * \brief MGUI::FORM_BUTTONTEXT class definitions
 *
 * \if NODOC
 * $Id: formbtxt.h_v 1.6 2004/07/27 13:33:34 mju Exp $
 *
 * $Log: formbtxt.h_v $
 * Revision 1.6  2004/07/27 13:33:34  mju
 * Un-deprecate template methods.
 *
 * Revision 1.5  2004/07/22 14:55:19  mju
 * Use MISTRING so can use textid.
 *
 * Revision 1.4  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.3  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.2  2003/04/09 20:49:59  dwilliss
 * Don't use _T in templates. Mac's ctype.h defines a global _T
 *
 * Revision 1.1  2002/10/09 16:20:16  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MGUI_FORMBTXT_H
#define  INC_MGUI_FORMBTXT_H

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


namespace MGUI {

//===================================================================================================================
//! Form containing PUSHBUTTON and non-editable text field.
class FORM_BUTTONTEXT : public MGUI::FORM_COMPOSITE {
   public:

      //! Constructor.
      FORM_BUTTONTEXT (
         );

      //! Clear the text field.
      void ClearText (
         ) {
         #ifdef WIN32_MFC
            m_Text.SetWindowText("");
         #else
            m_Text.ClearValue(false);
         #endif
         }

      //! Create with label from resource lookup.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane, //!< Parent pane
         const char *label,                  //!< Button label string for resource lookup
         int width = 0,                      //!< Width in 'em' characters
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand
         );

      //! Create with MISTRING label.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane, //!< Parent pane
         const MISTRING& label,              //!< Button label string
         int width = 0,                      //!< Width in 'em' characters
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand
         );

      //! Get reference to button control.
      CTRL_PUSHBUTTON& GetButton (
         ) { return (m_Button); }

      //! Set text to show in field.
      void SetText (
         const MISTRING& string
         );

   protected:

      virtual void OnPressed (
         ) = 0;

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
   #ifdef WIN32_MFC
      class MyEdit : public CEdit {
         public:
            virtual BOOL PreCreateWindow (CREATESTRUCT& cs);
         };
      MyEdit m_Text;
   #else
      CTRL_EDIT_STRING m_Text;
   #endif

      CTRL_PUSHBUTTON_T<FORM_BUTTONTEXT> m_Button;

      void CreateText (int width, LAYOUT_SIZEALIGN sizealign);

      FORM_BUTTONTEXT (const FORM_BUTTONTEXT&);
      FORM_BUTTONTEXT& operator= (const FORM_BUTTONTEXT&);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


//===================================================================================================================
//! Convenience template for FORM_BUTTONTEXT to allow container method to be called.
template <class _CT> class FORM_BUTTONTEXT_T : public MGUI::FORM_BUTTONTEXT {
   public:

      //! Constructor.
      FORM_BUTTONTEXT_T (
         ): m_pContainer(0), m_pfOnPressed(0) { }

      //! Create the control with label from resource lookup.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const char* label,                     //!< Label string for resource lookup
         _CT *pContainer,                       //!< Pointer to callback container class
         void (_CT::*pfOnPressed)(),               //! Callback function pointer
         int width = 0,                         //!< Width in 'em' characters
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand
         ) {
         m_pContainer = pContainer;
         m_pfOnPressed = pfOnPressed;
         FORM_BUTTONTEXT::Create(ParentPane,label,width,sizealign);
         return;
         }

      //! Create the control with Unicode label.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const MISTRING& label,                 //!< Label string
         _CT *pContainer,                       //!< Pointer to callback container class
         void (_CT::*pfOnPressed)(),            //! Callback function pointer
         int width = 0,                         //!< Width in 'em' characters
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand
         ) {
         m_pContainer = pContainer;
         m_pfOnPressed = pfOnPressed;
         FORM_BUTTONTEXT::Create(ParentPane,label,width,sizealign);
         return;
         }

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

      //! Called when button is pushed.
      virtual void OnPressed (
         ) { (m_pContainer->*m_pfOnPressed)(); }
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


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

}  // End namespace MGUI

#endif   // INC_MGUI_FORMBTXT_H

---