mgui/formbook.h

Go to the documentation of this file.

#ifndef  INC_MGUI_FORMBOOK_H
#define  INC_MGUI_FORMBOOK_H

#ifndef INC_MGUI_FORM_H
#include <mgui/form.h>
#endif

namespace MGUI {

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

class FORM_BOOK : public FORM_COMPOSITE {
   public:

      enum PAGESTYLE {
         PAGESTYLE_Default =              0,
         PAGESTYLE_IgnoreNonVisible =     0x01,    
         };

      FORM_BOOK ();

      virtual ~FORM_BOOK ();

      int AddPage (
         MGUI::LAYOUT_ORIENTATION orientation = MGUI::LAYOUT_ORIENTATION_Vertical,
         PAGESTYLE pagestyle = PAGESTYLE_Default,
         int ChildSpacing = 4,
         int ExtraBorder = 0
         );

      void Create (
         MGUI::LAYOUT_PANE_BASE& PaneParent,
         LAYOUT_SIZEALIGN sizealign = LAYOUT_SIZEALIGN_FixedSize,
         int ExtraBorder = 0
         );

      int GetActivePage () const
         { return (m_ActivePage); }

      MGUI::ID GetPageID (
         int pageindex                          
         ) const { return (m_PageIds.IsEmpty() ? 0 : m_PageIds[pageindex]); }

      LAYOUT_PANE& GetPagePane (
         int pageindex                          
         ) { return (*m_PagePanePtrs[pageindex]); }

      int GetNumPages () const
         { return (m_PagePanePtrs.GetNumItems()); }

      void SetActivePage (
         int pageindex                          
         );

      void SetActivePageID (
         MGUI::ID id
         );

      void SetPageID (
         int pageindex,                         
         MGUI::ID id
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      SIMPLE_ARRAY<LAYOUT_PANE*> m_PagePanePtrs;
      SIMPLE_ARRAY<MGUI::ID> m_PageIds;
      int m_ActivePage;

      FORM_BOOK (const FORM_BOOK&);
      FORM_BOOK& operator= (const FORM_BOOK&);
      #endif
   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(FORM_BOOK::PAGESTYLE)
#endif

//=====================================================================================================================
}  // End namespace MGUI

#endif   // INC_MGUI_FORMBOOK_H

---