form.h

Go to the documentation of this file.

/**
 * \file mgui/form.h
 * \brief Definitions for MGUI::FORM interface class.
 *
 * \if NODOC
 * $Id: form.h_v 1.10 2006/02/28 21:02:51 mju Exp $
 *
 * $Log: form.h_v $
 * Revision 1.10  2006/02/28 21:02:51  mju
 * Add docs for setFocus.
 *
 * Revision 1.9  2004/04/08 21:22:58  mju
 * Change setfocus to v_setfocus and use inline to call.
 *
 * Revision 1.8  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.7  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.6  2002/10/11 15:27:56  mju
 * Fix guard test.
 *
 * Revision 1.5  2002/10/09 15:10:56  mju
 * Moved to mgui include folder.
 * Make GetSML... not inline as virtuals should not be inline.
 *
 * Revision 1.4  2002/09/03 22:37:27  dwilliss
 * Added virtual method to support SML hooks
 *
 * Revision 1.3  2002/08/08 17:06:48  mju
 * Add GetDlgParent to form_composite.
 *
 * Revision 1.2  2001/12/13 16:58:11  mju
 * MGUI unification with X.
 *
 * Revision 1.1  2001/11/30 17:27:32  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_MGUI_FORM_H
#define  INC_MGUI_FORM_H

#ifndef INC_MGUI_LAYOUT_H
#include <mgui/layout.h>
#endif

class SML_GUI_INTERFACE_BASE; //!< Hook for the SML interface to MGUI controls

namespace MGUI {

//------------------------------------------------------------------------------------------------
//! Interface class for graphical user interface controls and forms.

class FORM {
   public:

      //! Destructor.
      virtual ~FORM (
         ) = 0;

      //! Determine if form has been created.
      //! @return true if created, false if not.
      virtual bool IsCreated (
         ) const = 0;

      //! Set whether mouse or keyboard input to form is allowed.
      virtual void SetEnabled (
         bool enabled = true
         ) = 0;

      //! Set focus to first interactive control in form.
      //! If calling for a DLGSHELL should be done in v_OnOpen, cannot
      //! be done in v_CreateContent.
      void SetFocus (
         ) const { v_SetFocus(); }

      //! Set whether form is visible or not.
      virtual void SetVisible (
         bool visible = true
         ) = 0;

      #ifndef GENERATING_DOXYGEN_OUTPUT
      //! Function private to SML implementation of MGUI classes.
      //! Used to prevent the need for ugly multiple inheritance.
      virtual SML_GUI_INTERFACE_BASE* GetSMLInterface (
         );
      #endif // GENERATING_DOXYGEN_OUTPUT

   private:

      //! Set focus to first interactive control in form.
      //! Default implementation does nothing.
      virtual void v_SetFocus (
         ) const;

   };

//------------------------------------------------------------------------------------------------
//! Base class for composite forms.
class FORM_COMPOSITE : public MGUI::FORM {
   public:

      //! Constructor.
      FORM_COMPOSITE (
         );

      //! Destructor.
      virtual ~FORM_COMPOSITE (
         ) = 0;

      //! Get suitable parent for dialog launched from form.
      MDLGPARENT GetDlgParent (
         ) const { return (m_pane.GetDlgParent()); }

      //! Determine if form has been created.
      //! @return true if created, false if not.
      virtual bool IsCreated (
         ) const;

      //! Set whether mouse or keyboard input to form is allowed.
      virtual void SetEnabled (
         bool enabled = true
         );

      //! Set whether form is visible or not.
      virtual void SetVisible (
         bool visible = true
         );

   protected:

      //! Create layout pane.
      //! Use GetPane() to retrieve reference to pane.
      void CreatePane (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< 'Parent' pane
         MGUI::LAYOUT_ORIENTATION orientation,  //!< Pane orientation
         MGUI::LAYOUT_SIZEALIGN sizealign,      //!< Sizing and alignment
         int ChildSpacing = 4,                  //!< Spacing between 'children' of pane
         int ExtraBorder = 0                    //!< Extra border around pane, in addition to ChildSpacing
         ) { m_pane.Create(ParentPane,orientation,sizealign,ChildSpacing,ExtraBorder); }

      //! Get layout pane.
      MGUI::LAYOUT_PANE& GetPane (
         ) { return (m_pane); }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      LAYOUT_PANE m_pane;

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

//------------------------------------------------------------------------------------------------
}  // End namespace MGUI

#endif   // INC_MGUI_FORM_H

---