wxRuby Documentation Home

# Wx::CloseEvent

This event class contains information about window and session close events.

The handler function for EVT_CLOSE is called when the user has tried to close a a frame
or dialog box using the window manager (X) or system menu (Windows). It can
also be invoked by the application itself programmatically, for example by
calling the Window#close function.

You should check whether the application is forcing the deletion of the window
using CloseEvent#can_veto. If this is `false`,
you must destroy the window using Window#destroy.
If the return value is true, it is up to you whether you respond by destroying the window.

If you don’t destroy the window, you should call CloseEvent#veto to
let the calling code know that you did not destroy the window. This allows the Window#close function
to return `true` or `false` depending on whether the close instruction was honoured or not.

## Derived from

Event

## Event table macros

To process a close event, use these event handler macros to direct input to member
functions that take a CloseEvent argument.

evt_close() { | event | … } | Process a close event, supplying the member function. Thisevent applies to Frame and Dialog classes.
evt_query_end_session() { | event | … } | Process a query end session event, supplying the member function.This event applies to App only.
evt_end_session() { | event | … } | Process an end session event, supplying the member function.This event applies to App only.

## See also

Window#close, Window deletion overview

## Methods

- CloseEvent.new
- CloseEvent#can_veto
- CloseEvent#get_logging_off
- CloseEvent#set_can_veto
- CloseEvent#set_force
- CloseEvent#set_logging_off
- CloseEvent#veto

### CloseEvent.new

CloseEvent.new(%(arg-type)TYPE% commandEventType = 0, Integer id = 0)

Constructor.

### CloseEvent#can_veto

Boolean can_veto()

Returns true if you can veto a system shutdown or a window close event.
Vetoing a window close event is not possible if the calling code wishes to
force the application to exit, and so this function must be called to check this.

### CloseEvent#get_logging_off

Boolean get_logging_off()

Returns true if the user is just logging off or false if the system is
shutting down. This method can only be called for end session and query end
session events, it doesn’t make sense for close window event.

### CloseEvent#set_can_veto

set_can_veto(%(arg-type)Boolean% canVeto)

Sets the ‘can veto’ flag.

### CloseEvent#set_force

set_force(%(arg-type)Boolean% force)

Sets the ‘force’ flag.

### CloseEvent#set_logging_off

set_logging_off(%(arg-type)Boolean% loggingOff)

Sets the ‘logging off’ flag.

### CloseEvent#veto

veto(%(arg-type)Boolean% veto = true)

Call this from your event handler to veto a system shutdown or to signal
to the calling application that a window close did not happen.

You can only veto a shutdown if CloseEvent#can_veto returns
true.

[This page automatically generated from the Textile source at 2023-06-09 00:45:25 +0000]