Wireshark 4.7.0
The Wireshark network protocol analyzer
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ShutdownEvent Class Reference

An event object passed to shutdown listeners to allow vetoing. More...

#include <software_update.h>

Public Member Functions

void accept ()
 Signal that this listener consents to the shutdown.
 
void reject (const QString &reason={})
 Veto the shutdown with an optional explanatory message.
 
bool isAccepted () const
 Return whether the shutdown has been accepted.
 
QString reason () const
 Return the reason provided to the most recent reject() call.
 

Detailed Description

An event object passed to shutdown listeners to allow vetoing.

Member Function Documentation

◆ isAccepted()

bool ShutdownEvent::isAccepted ( ) const

Return whether the shutdown has been accepted.

Returns
true if accept() was called and reject() was not.

◆ reason()

QString ShutdownEvent::reason ( ) const

Return the reason provided to the most recent reject() call.

Returns
The rejection reason string, or an empty string if the shutdown was not rejected.

◆ reject()

void ShutdownEvent::reject ( const QString &  reason = {})

Veto the shutdown with an optional explanatory message.

Parameters
reasonA human-readable string explaining why the shutdown is being blocked, shown to the user. May be empty.

The documentation for this class was generated from the following files: