mgui/form.h

Go to the documentation of this file.

#ifndef  INC_MGUI_FORM_H
#define  INC_MGUI_FORM_H

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


#ifndef GENERATING_DOXYGEN_OUTPUT
class SML_GUI_INTERFACE_BASE; // Hook for the SML interface to MGUI controls
#endif


namespace MGUI {

//------------------------------------------------------------------------------------------------

class FORM {
   public:

      virtual ~FORM (
         ) = 0;

      virtual bool IsCreated (
         ) const = 0;

      virtual void SetEnabled (
         bool enabled = true
         ) = 0;

      void SetFocus (
         ) const { v_SetFocus(); }

      virtual void SetVisible (
         bool visible = true
         ) = 0;

      #ifndef GENERATING_DOXYGEN_OUTPUT
      virtual SML_GUI_INTERFACE_BASE* GetSMLInterface (
         );
      #endif // GENERATING_DOXYGEN_OUTPUT

   private:

      virtual void v_SetFocus (
         ) const;

   };

//------------------------------------------------------------------------------------------------
class FORM_COMPOSITE : public MGUI::FORM {
   public:

      FORM_COMPOSITE (
         );

      virtual ~FORM_COMPOSITE (
         ) = 0;

      MDLGPARENT GetDlgParent (
         ) const { return (m_pane.GetDlgParent()); }

      virtual bool IsCreated (
         ) const;

      bool IsVisible (
         ) const { return (m_pane.IsVisible()); }

      virtual void SetEnabled (
         bool enabled = true
         );

      virtual void SetVisible (
         bool visible = true
         );

   protected:

      void CreatePane (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    
         MGUI::LAYOUT_ORIENTATION orientation,  
         MGUI::LAYOUT_SIZEALIGN sizealign,      
         int ChildSpacing = 4,                  
         int ExtraBorder = 0                    
         ) { m_pane.Create(ParentPane,orientation,sizealign,ChildSpacing,ExtraBorder); }

      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

---