ModClose.h

Go to the documentation of this file.

/*********************************************************\
 *  File: ModClose.h                                     *
 *
 *  Copyright (C) 2002-2011 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_MODCLOSE_H__
#define __PLGUI_MODCLOSE_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLGui/Modifiers/Modifier.h"


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


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Modifier that adds actions to the close button (close window or exit application)
*/
class ModClose : public Modifier {


    //[-------------------------------------------------------]
    //[ Class definition                                      ]
    //[-------------------------------------------------------]
    pl_class(PLGUI_RTTI_EXPORT, ModClose, "PLGui", PLGui::Modifier, "Modifier that adds actions to the close button (close window or exit application)")
        // Attributes
        pl_attribute(CloseWindow,       bool,   false,  ReadWrite,  DirectValue,    "Destroy window on 'close'-button?",    "")
        pl_attribute(ExitApplication,   bool,   false,  ReadWrite,  DirectValue,    "Exit application on 'close'-button?",  "")
        // Constructors
        pl_constructor_0(DefaultConstructor,    "Default constructor",  "")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        */
        PLGUI_API ModClose();

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


    //[-------------------------------------------------------]
    //[ Protected virtual Modifier functions                  ]
    //[-------------------------------------------------------]
    protected:
        virtual void OnAttach(Widget &cWidget) override;
        virtual void OnDetach(Widget &cWidget) override;


    //[-------------------------------------------------------]
    //[ Protected virtual WidgetFunctions functions           ]
    //[-------------------------------------------------------]
    protected:
        virtual void OnClose() override;


};


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


#endif // __PLGUI_MODCLOSE_H__