Box.h

Go to the documentation of this file.

/*********************************************************\
 *  File: Box.h                                          *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLGUI_BOX_H__
#define __PLGUI_BOX_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLGui/Widgets/Widget.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLGui {


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class LayoutBox;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Box container widget (using LayoutBox)
*/
class Box : public Widget {


    //[-------------------------------------------------------]
    //[ Class definition                                      ]
    //[-------------------------------------------------------]
    pl_class(PLGUI_RTTI_EXPORT, Box, "PLGui", PLGui::Widget, "Box container widget (using LayoutBox)")
        // Attributes
        pl_attribute(Orientation,   pl_enum_type(EOrientation), Horizontal, ReadWrite,  GetSet, "Box orientation",  "")
        // Constructors
        pl_constructor_0(DefaultConstructor,    "Default constructor",  "")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] pParent
        *    Pointer to parent widget
        *  @param[in] nOrientation
        *    Orientation
        */
        PLGUI_API Box(Widget *pParent = nullptr, EOrientation nOrientation = Horizontal);

        /**
        *  @brief
        *    Destructor
        */
        PLGUI_API virtual ~Box();

        /**
        *  @brief
        *    Get orientation of box
        *
        *  @return
        *    Orientation
        */
        PLGUI_API EOrientation GetOrientation() const;

        /**
        *  @brief
        *    Set orientation of box
        *
        *  @param[in] nOrientation
        *    Orientation
        */
        PLGUI_API void SetOrientation(EOrientation nOrientation);


    //[-------------------------------------------------------]
    //[ Private virtual Widget functions                      ]
    //[-------------------------------------------------------]
    private:
        virtual PLMath::Vector2i OnPreferredSize(const PLMath::Vector2i &vRefSize) const override;


    //[-------------------------------------------------------]
    //[ Protected data                                        ]
    //[-------------------------------------------------------]
    protected:
        LayoutBox *m_pBoxLayout;    /**< Box layout */


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLGui


#endif // __PLGUI_BOX_H__