Bitmap.h

Go to the documentation of this file.

/*********************************************************\
 *  File: Bitmap.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_BITMAP_H__
#define __PLGUI_BITMAP_H__
#pragma once


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


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


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Widget that displays a static image
*/
class Bitmap : public Widget {


    //[-------------------------------------------------------]
    //[ Class definition                                      ]
    //[-------------------------------------------------------]
    pl_class(PLGUI_RTTI_EXPORT, Bitmap, "PLGui", PLGui::Widget, "Widget that displays a static image")
        // Attributes
        pl_attribute(ImageName, PLCore::String, "", ReadWrite,  GetSet, "Image filename",   "")
        // Constructors
        pl_constructor_0(DefaultConstructor,    "Default constructor",  "")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] pParent
        *    Pointer to parent widget
        */
        PLGUI_API Bitmap(Widget *pParent = nullptr);

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

        /**
        *  @brief
        *    Get image
        *
        *  @return
        *    Image
        */
        PLGUI_API const Image &GetImage() const;

        /**
        *  @brief
        *    Set image
        *
        *  @param[in] cImage
        *    Image
        */
        PLGUI_API void SetImage(const Image &cImage);

        /**
        *  @brief
        *    Get image filename
        *
        *  @return
        *    Image that is displayed on the button
        */
        PLGUI_API PLCore::String GetImageName() const;

        /**
        *  @brief
        *    Set image filename
        *
        *  @param[in] sImage
        *    Image that is displayed on the button
        */
        PLGUI_API void SetImageName(const PLCore::String &sImage);


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


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        // Private data
        Image m_cImage;     /**< Displayed image */


};


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


#endif // __PLGUI_BITMAP_H__