mrpt::gui::mrptEventWindowClosed Class Reference

Detailed Description

An event sent by a window upon when it's about to be closed, either manually by the user or programmatically.

The event field member allow_close is default by default, but can be set to false in the event callback to forbid the window to be closed by the user. If the event corresponds to a programatic close, this field is ignored.

IMPORTANTE NOTICE: Event handlers in your observer class will be invoked from the wxWidgets internal MRPT thread, so all your code in the handler must be thread safe.

See also

CBaseGUIWindow

Definition at line 283 of file CBaseGUIWindow.h.

#include <mrpt/gui/CBaseGUIWindow.h>

Inheritance diagram for mrpt::gui::mrptEventWindowClosed:

Public Member Functions
	mrptEventWindowClosed (CBaseGUIWindow *obj, bool _allow_close=true)
template<class EVENTTYPE >
bool	isOfType () const
template<class EVENTTYPE >
const EVENTTYPE *	getAs () const
template<class EVENTTYPE >
EVENTTYPE *	getAsNonConst () const

Public Attributes
CBaseGUIWindow *	source_object
bool	allow_close
mrpt::system::TTimeStamp	timestamp

Protected Member Functions
virtual void	do_nothing () override
	Just to allow this class to be polymorphic. More...

Constructor & Destructor Documentation

mrptEventWindowClosed()

mrpt::gui::mrptEventWindowClosed::mrptEventWindowClosed ( CBaseGUIWindow *  obj, bool  _allow_close = true  )

inline

Definition at line 289 of file CBaseGUIWindow.h.

Member Function Documentation

do_nothing()

virtual void mrpt::gui::mrptEventWindowClosed::do_nothing ( )

inlineoverrideprotectedvirtual

Just to allow this class to be polymorphic.

Reimplemented from mrpt::utils::mrptEvent.

Definition at line 287 of file CBaseGUIWindow.h.

getAs()

template<class EVENTTYPE >

const EVENTTYPE* mrpt::utils::mrptEvent::getAs ( ) const

inlineinherited

Definition at line 49 of file mrptEvent.h.

getAsNonConst()

template<class EVENTTYPE >

EVENTTYPE* mrpt::utils::mrptEvent::getAsNonConst ( ) const

inlineinherited

Definition at line 55 of file mrptEvent.h.

isOfType()

template<class EVENTTYPE >

bool mrpt::utils::mrptEvent::isOfType ( ) const

inlineinherited

Definition at line 43 of file mrptEvent.h.

Referenced by mrpt::graphslam::CWindowObserver::OnEvent(), and mrpt::slam::COccupancyGridMapFeatureExtractor::OnEvent().

Here is the caller graph for this function:

Member Data Documentation

allow_close

bool mrpt::gui::mrptEventWindowClosed::allow_close

Definition at line 294 of file CBaseGUIWindow.h.

Referenced by mrpt::gui::CWindowDialog::OnClose(), mrpt::gui::C3DWindowDialog::OnClose(), and mrpt::gui::CWindowDialogPlots::OnClose().

source_object

CBaseGUIWindow* mrpt::gui::mrptEventWindowClosed::source_object

Definition at line 293 of file CBaseGUIWindow.h.

Referenced by mrpt::graphslam::CWindowObserver::OnEvent().

timestamp

mrpt::system::TTimeStamp mrpt::utils::mrptEvent::timestamp

inherited

Definition at line 60 of file mrptEvent.h.