formrbtn.h

Go to the documentation of this file.

/**
 * \file mgui/formrbtn.h
 * \brief MGUI::FORM_RADIOBUTTONS class definitions
 *
 * \if NODOC
 * $Id: formrbtn.h_v 1.10 2004/03/11 18:26:04 mju Exp $
 *
 * $Log: formrbtn.h_v $
 * Revision 1.10  2004/03/11 18:26:04  mju
 * Change setenabled to setEnabledID.
 *
 * Revision 1.9  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.8  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.7  2003/09/10 21:18:44  mju
 * Use MGUI::ID for id.
 *
 * Revision 1.6  2003/04/09 20:50:49  dwilliss
 * Don't use _T in templates.  Mac's ctype.h defines a global _T
 *
 * Revision 1.4  2003/01/21 17:59:25  mju
 * Add ChildSpacing parm to Create.
 *
 * Revision 1.3  2003/01/16 21:42:35  mju
 * Include mgui/listitem.h
 *
 * Revision 1.2  2002/10/14 20:52:11  mju
 * Add CreateButton versions using ICONID.
 * Add SetEnabled.
 * Add template version.
 *
 * Revision 1.1  2002/10/09 16:20:27  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_MGUI_FORMRBTN_H
#define  INC_MGUI_FORMRBTN_H

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

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


namespace MGUI {

//===================================================================================================================
//! Container form for set of radio buttons, with enforcement of radio behavior.
class FORM_RADIOBUTTONS : public MGUI::FORM_COMPOSITE {
   public:

      //! Constructor.
      FORM_RADIOBUTTONS (
         );

      //! Destructor.
      virtual ~FORM_RADIOBUTTONS (
         );

      //! Add button with string from resource lookup.
      void AddButton (
         ID id,                                 //!< ID to attach to item
         const char *string                     //!< String for resource lookup
         );

      //! Add button with Unicode string.
      void AddButton (
         ID id,                                 //!< ID to attach to button
         const UNICODE* string                  //!< String for button
         );

      //! Add icon button with tooltip from resource lookup.
      void AddButton (
         ID id,                                 //!< ID to attach to item
         ICONID iconid,                         //!< Icon ID
         const char *tooltip,                   //!< ToolTip for resource lookup
         int iconsize = 0                       //!< Icon size, 0 for default
         );

      //! Add icon button with Unicode tooltip.
      void AddButton (
         ID id,                                 //!< ID to attach to button
         ICONID iconid,                         //!< Icon ID
         const UNICODE* tooltip,                //!< ToolTip string
         int iconsize = 0                       //!< Icon size, 0 for default
         );

      //! Add multiple buttons.
      void AddButtons (
         const MGUI::LISTITEMDEF *buttons       //!< Buttons to add, terminated by button with NULL string
         );

      //! Create control.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const MGUI::LISTITEMDEF *buttons = 0,  //!< Initial button set, 0 for none
         MGUI::LAYOUT_ORIENTATION orientation = MGUI::LAYOUT_ORIENTATION_Vertical,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize,
         int ChildSpacing = 4                   //!< Spacing between children
         );

      //! Get ID of currently selected button.
      //! @return ID or -1 if none selected.
      ID GetSelectedID (
         ) const;

      //! Set whether individual button is enabled or not.
      void SetEnabledID (
         ID id,                                 //!< ID of button to enable/disable
         bool enabled = true                    //!< 'true' to enable, 'false' to disable
         );

      //! Select button using ID.
      //! If button does not exist then no button will appear selected
      void SetSelectedID (
         ID id                                  //!< ID of button to select
         );

   protected:

      //! Called when user makes selection.
      virtual void OnSelection ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      class BUTTON : public MGUI::CTRL_TOGGLEBUTTON {
         public:
            BUTTON (FORM_RADIOBUTTONS& Container) : m_Container(Container) { }
         private:
            FORM_RADIOBUTTONS& m_Container;
            virtual void OnPressed ();
         };
      friend class MGUI::FORM_RADIOBUTTONS::BUTTON;

      typedef MILIST<BUTTON*> BUTTONLIST;

      BUTTONLIST m_ButtonList;
      SIMPLE_ARRAY<ID> m_IdArray;

      CTRL_TOGGLEBUTTON::STYLE GetRadioStyle (
         ) const {
      #ifdef WIN32_MFC
         return (m_ButtonList.IsEmpty() ? CTRL_TOGGLEBUTTON::STYLE_RadioFirst : CTRL_TOGGLEBUTTON::STYLE_Radio);
      #else
         return (CTRL_TOGGLEBUTTON::STYLE_Radio);
      #endif
         }

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

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

      //! Constructor.
      explicit FORM_RADIOBUTTONS_T (
         ): m_pContainer(0), m_pfOnSelection(0) { }

      //! Create control with label from resource lookup.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         _CT *pContainer,                       //!< Pointer to callback container class
         void (_CT::*pfOnSelection)(),          //! Callback function pointer
         const MGUI::LISTITEMDEF *buttons = 0,  //!< Initial button set, 0 for none
         MGUI::LAYOUT_ORIENTATION orientation = MGUI::LAYOUT_ORIENTATION_Vertical,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize,
         int ChildSpacing = 4                   //!< Spacing between children
         ) {
         m_pContainer = pContainer;
         m_pfOnSelection = pfOnSelection;
         FORM_RADIOBUTTONS::Create(ParentPane,buttons,orientation,sizealign,ChildSpacing);
         }

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

      virtual void OnSelection (
         ) { (m_pContainer->*m_pfOnSelection)(); }
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


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

}  // End namespace MGUI

#endif   // INC_MGUI_FORMRBTN_H

---