Version: 3.1.0
wxShowEvent Class Reference

#include <wx/event.h>

+ Inheritance diagram for wxShowEvent:

Detailed Description

An event being sent when the window is shown or hidden.

The event is triggered by calls to wxWindow::Show(), and any user action showing a previously hidden window or vice versa (if allowed by the current platform and/or window manager). Notice that the event is not triggered when the application is iconized (minimized) or restored under wxMSW.

Availability:  only available for the wxMSW, wxGTK ports.

Events using this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxShowEvent& event)

Event macros:

  • EVT_SHOW(func):
    Process a wxEVT_SHOW event.

Library:  wxCore
Category:  Events
See Also
Events and Event Handling, wxWindow::Show, wxWindow::IsShown

Public Member Functions

 wxShowEvent (int winid=0, bool show=false)
 Constructor.
 
void SetShow (bool show)
 Set whether the windows was shown or hidden.
 
bool IsShown () const
 Return true if the window has been shown, false if it has been hidden.
 
bool GetShow () const
 
- Public Member Functions inherited from wxEvent
 wxEvent (int id=0, wxEventType eventType=wxEVT_NULL)
 Constructor.
 
virtual wxEventClone () const =0
 Returns a copy of the event.
 
wxObjectGetEventObject () const
 Returns the object (usually a window) associated with the event, if any.
 
wxEventType GetEventType () const
 Returns the identifier of the given event type, such as wxEVT_BUTTON.
 
virtual wxEventCategory GetEventCategory () const
 Returns a generic category for this event.
 
int GetId () const
 Returns the identifier associated with this event, such as a button command id.
 
wxObjectGetEventUserData () const
 Return the user data associated with a dynamically connected event handler.
 
bool GetSkipped () const
 Returns true if the event handler should be skipped, false otherwise.
 
long GetTimestamp () const
 Gets the timestamp for the event.
 
bool IsCommandEvent () const
 Returns true if the event is or is derived from wxCommandEvent else it returns false.
 
void ResumePropagation (int propagationLevel)
 Sets the propagation level to the given value (for example returned from an earlier call to wxEvent::StopPropagation).
 
void SetEventObject (wxObject *object)
 Sets the originating object.
 
void SetEventType (wxEventType type)
 Sets the event type.
 
void SetId (int id)
 Sets the identifier associated with this event, such as a button command id.
 
void SetTimestamp (long timeStamp=0)
 Sets the timestamp for the event.
 
bool ShouldPropagate () const
 Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0.
 
void Skip (bool skip=true)
 This method can be used inside an event handler to control whether further event handlers bound to this event will be called after the current one returns.
 
int StopPropagation ()
 Stop the event from propagating to its parent window.
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data.
 
 wxObject (const wxObject &other)
 Copy ctor.
 
virtual ~wxObject ()
 Destructor.
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class.
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj.
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone.
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer.
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data.
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public.
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined.
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined.
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object.
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it.
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data.
 
- Protected Attributes inherited from wxEvent
int m_propagationLevel
 Indicates how many levels the event can propagate.
 

Constructor & Destructor Documentation

wxShowEvent::wxShowEvent ( int  winid = 0,
bool  show = false 
)

Constructor.

Member Function Documentation

bool wxShowEvent::GetShow ( ) const
Deprecated:
This function is deprecated in favour of IsShown().
bool wxShowEvent::IsShown ( ) const

Return true if the window has been shown, false if it has been hidden.

void wxShowEvent::SetShow ( bool  show)

Set whether the windows was shown or hidden.