MRPT  1.9.9
List of all members | Public Member Functions | Public Attributes | Protected Member Functions
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

CBaseGUIWindowsource_object
 
bool allow_close
 
mrpt::Clock::time_point timestamp
 

Protected Member Functions

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 290 of file CBaseGUIWindow.h.

Member Function Documentation

◆ do_nothing()

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

Just to allow this class to be polymorphic.

Reimplemented from mrpt::system::mrptEvent.

Definition at line 287 of file CBaseGUIWindow.h.

◆ getAs()

template<class EVENTTYPE >
const EVENTTYPE* mrpt::system::mrptEvent::getAs ( ) const
inlineinherited

Definition at line 47 of file mrptEvent.h.

◆ getAsNonConst()

template<class EVENTTYPE >
EVENTTYPE* mrpt::system::mrptEvent::getAsNonConst ( ) const
inlineinherited

Definition at line 53 of file mrptEvent.h.

◆ isOfType()

template<class EVENTTYPE >
bool mrpt::system::mrptEvent::isOfType ( ) const
inlineinherited

Definition at line 41 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

◆ source_object

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

Definition at line 294 of file CBaseGUIWindow.h.

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

◆ timestamp

mrpt::Clock::time_point mrpt::system::mrptEvent::timestamp
inherited

Definition at line 58 of file mrptEvent.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: c7a3bec24 Sun Mar 29 18:33:13 2020 +0200 at dom mar 29 18:50:38 CEST 2020