mgui/formtabbed.h

Go to the documentation of this file.

#ifndef  INC_MGUI_FORMTABBED_H
#define  INC_MGUI_FORMTABBED_H

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

namespace MGUI {

#ifndef GENERATING_DOXYGEN_OUTPUT
class ICON;
#endif

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

class FORM_TABBED : public FORM_COMPOSITE {
   public:

      enum FORMSTYLE {
         FORMSTYLE_TabTopLeft =     0x00,    
         FORMSTYLE_TabTopRight =    0x01,    
         FORMSTYLE_TabBottomLeft =  0x02,    
         FORMSTYLE_TabBottomRight = 0x03,    
         FORMSTYLE_TabLeftTop =     0x04,    
         FORMSTYLE_TabLeftBottom =  0x05,    
         FORMSTYLE_TabRightTop =    0x06,    
         FORMSTYLE_TabRightBottom = 0x07,    
         FORMSTYLE_UseIcons =       0x08,    
      #ifndef GENERATING_DOXYGEN_OUTPUT
         FORMSTYLE_TabMask =        0x07,
      #endif
         };

      enum PAGESTYLE {
         PAGESTYLE_Default =              0,
         PAGESTYLE_IgnoreNonVisible =     0x01,    
         PAGESTYLE_Disabled =             0x02,    
         PAGESTYLE_ShowTextWithIcon =     0x04,    
         };

      FORM_TABBED ();

      virtual ~FORM_TABBED ();

      int AddPage (
         const MISTRING& label,                 
         MGUI::LAYOUT_ORIENTATION orientation = MGUI::LAYOUT_ORIENTATION_Vertical,
         PAGESTYLE pagestyle = PAGESTYLE_Default,
         int ChildSpacing = 4,
         int ExtraBorder = 4
         );

      int AddPage (
         const MGUI::ICON& icon,                
         const MISTRING& tooltip,               
         MGUI::LAYOUT_ORIENTATION orientation = MGUI::LAYOUT_ORIENTATION_Vertical,
         PAGESTYLE pagestyle = PAGESTYLE_Default,
         int ChildSpacing = 4,
         int ExtraBorder = 4
         );

      void Create (
         MGUI::LAYOUT_PANE_BASE& PaneParent,
         FORMSTYLE formstyle = FORMSTYLE_TabTopLeft,
         LAYOUT_SIZEALIGN sizealign = LAYOUT_SIZEALIGN_FixedSize
         );

      int GetActivePage (
         ) const;

      LAYOUT_PANE_BASE& GetPagePane (
         int pageindex                          
         );

      int GetNumPages (
         ) const;

      void SetActivePage (
         int pageindex                          
         );

      void SetDelegateOnPageActivate (
         DELEGATE_VOID_NOPARMS delegate,        
         int pageindex = -1                     
         );

      void SetDelegateOnPageDeactivate (
         DELEGATE_BOOL_NOPARMS delegate,        
         int pageindex = -1                     
         );

      void SetPageEnabled (
         int pageindex,                         
         bool enabled = true
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class PRIV;
      PRIV *m_pPriv;

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

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

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

#endif   // INC_MGUI_FORMTABBED_H

---