Line data    Source code

       1             : /****************************************************************************/
       2             : // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
       3             : // Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
       4             : // This program and the accompanying materials are made available under the
       5             : // terms of the Eclipse Public License 2.0 which is available at
       6             : // https://www.eclipse.org/legal/epl-2.0/
       7             : // This Source Code may also be made available under the following Secondary
       8             : // Licenses when the conditions for such availability set forth in the Eclipse
       9             : // Public License 2.0 are satisfied: GNU General Public License, version 2
      10             : // or later which is available at
      11             : // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
      12             : // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
      13             : /****************************************************************************/
      14             : /// @file    GUIEvent_CloseView.h
      15             : /// @author  Daniel Krajzewicz
      16             : /// @date    Wed 18 Jun 2003
      17             : ///
      18             : // Event send when a message (message, warning, error) has to besubmitted
      19             : /****************************************************************************/
      20             : #pragma once
      21             : #include <config.h>
      22             : 
      23             : #include "GUIEvent.h"
      24             : #include <string>
      25             : #include <utils/common/MsgHandler.h>
      26             : 
      27             : 
      28             : // ===========================================================================
      29             : // class definitions
      30             : // ===========================================================================
      31             : /**
      32             :  * GUIEvent_CloseView
      33             :  * Throw from GUIRunThread to GUIApplicationWindow and then further to all
      34             :  * displays after a step has been performed
      35             :  */
      36             : class GUIEvent_CloseView : public GUIEvent {
      37             : public:
      38             :     /// constructor
      39             :     GUIEvent_CloseView(const std::string& caption)
      40           4 :         : GUIEvent(GUIEventType::CLOSE_VIEW), myCaption(caption) {
      41           4 :     }
      42             : 
      43             :     /// destructor
      44           4 :     ~GUIEvent_CloseView() { }
      45             : 
      46             :     const std::string& getCaption() const {
      47           4 :         return myCaption;
      48             :     }
      49             : 
      50             : protected:
      51             : 
      52             :     /// The message
      53             :     std::string myCaption;
      54             : };