gtkmm  3.91.0
Public Member Functions | Related Functions | List of all members
Gdk::EventExpose Class Reference

Generated when all or part of a window becomes visible and needs to be redrawn. More...

#include <gdkmm/event.h>

Inheritance diagram for Gdk::EventExpose:
Inheritance graph
[legend]

Public Member Functions

 EventExpose ()
 Creates an invalid event object. More...
 
 EventExpose (GdkEventExpose* gobject, bool make_a_copy=false)
 Wraps a C event instance. More...
 
void swap (EventExpose& other) noexcept
 
GdkEventExpose* gobj ()
 Provides access to the underlying C instance. More...
 
const GdkEventExpose* gobj () const
 Provides access to the underlying C instance. More...
 
GdkEventExpose* gobj_copy () const
 Provides access to the underlying C instance. More...
 
const Gdk::Rectangleget_area () const
 Returns the bounding box of the region to be redrawn. More...
 
::Cairo::RefPtr< const ::Cairo::Regionget_region () const
 Returns the region to be redrawn. More...
 
int get_count () const
 Returns the number of contiguous Gdk::Event::Type::EXPOSE events following this one. More...
 
- Public Member Functions inherited from Gdk::Event
 Event ()
 Creates an invalid event object. More...
 
 Event (GdkEvent* gobject, bool make_a_copy=false)
 Wraps a C event instance. More...
 
 Event (const Event& other)
 
Eventoperator= (const Event& other)
 
 Event (Event&& other) noexcept
 
Eventoperator= (Event&& other) noexcept
 
 ~Event () noexcept
 
void swap (Event& other) noexcept
 
GdkEvent* gobj ()
 Provides access to the underlying C instance. More...
 
const GdkEvent* gobj () const
 Provides access to the underlying C instance. More...
 
GdkEvent* gobj_copy () const
 Provides access to the underlying C instance. More...
 
Event::Type get_event_type () const
 Retrieves the type of the event. More...
 
Glib::RefPtr< Gdk::Windowget_window ()
 Returns the window which received the event. More...
 
Glib::RefPtr< const Gdk::Windowget_window () const
 
bool is_send_event () const
 Returns true if the event was sent explicitly (e.g. More...
 
Glib::RefPtr< Screenget_screen ()
 Returns the screen for the event. More...
 
Glib::RefPtr< const Screenget_screen () const
 Returns the screen for the event. More...
 
Glib::RefPtr< Seatget_seat ()
 Returns the Gdk::Seat this event was generated for. More...
 
Glib::RefPtr< const Seatget_seat () const
 Returns the Gdk::Seat this event was generated for. More...
 
void put ()
 Appends a copy of the given event onto the front of the event queue for event->any.window’s display, or the default event queue if event->any.window is nullptr. More...
 

Related Functions

(Note that these are not member functions.)

void swap (EventExpose& lhs, EventExpose& rhs) noexcept
 
const EventExposewrap_event (const GdkEventExpose*& event)
 Wraps a C event instance without making unnecessary copy when the ownership can not be acquired. More...
 
EventExposewrap_event (GdkEventExpose*& event)
 See wrap_event(const GdkEventExpose*& event). More...
 
Gdk::EventExpose wrap (GdkEventExpose* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

- Public Types inherited from Gdk::Event
enum  Type {
  Type::NOTHING = -1,
  Type::DELETE = 0,
  Type::DESTROY = 1,
  Type::EXPOSE = 2,
  Type::MOTION_NOTIFY = 3,
  Type::BUTTON_PRESS = 4,
  Type::DOUBLE_BUTTON_PRESS = 5,
  Type::TRIPLE_BUTTON_PRESS = 6,
  Type::BUTTON_RELEASE = 7,
  Type::KEY_PRESS = 8,
  Type::KEY_RELEASE = 9,
  Type::ENTER_NOTIFY = 10,
  Type::LEAVE_NOTIFY = 11,
  Type::FOCUS_CHANGE = 12,
  Type::CONFIGURE = 13,
  Type::MAP = 14,
  Type::UNMAP = 15,
  Type::PROPERTY_NOTIFY = 16,
  Type::SELECTION_CLEAR = 17,
  Type::SELECTION_REQUEST = 18,
  Type::SELECTION_NOTIFY = 19,
  Type::PROXIMITY_IN = 20,
  Type::PROXIMITY_OUT = 21,
  Type::DRAG_ENTER = 22,
  Type::DRAG_LEAVE = 23,
  Type::DRAG_MOTION = 24,
  Type::DRAG_STATUS = 25,
  Type::DROP_START = 26,
  Type::DROP_FINISHED = 27,
  Type::CLIENT_EVENT = 28,
  Type::VISIBILITY_NOTIFY = 29,
  Type::SCROLL = 31,
  Type::WINDOW_STATE = 32,
  Type::SETTING = 33,
  Type::OWNER_CHANGE = 34,
  Type::GRAB_BROKEN = 35,
  Type::DAMAGE = 36,
  Type::TOUCH_BEGIN = 37,
  Type::TOUCH_UPDATE = 38,
  Type::TOUCH_END = 39,
  Type::TOUCH_CANCEL = 40,
  Type::TOUCHPAD_SWIPE = 41,
  Type::TOUCHPAD_PINCH = 42,
  Type::PAD_BUTTON_PRESS = 43,
  Type::PAD_BUTTON_RELEASE = 44,
  Type::PAD_RING = 45,
  Type::PAD_STRIP = 46,
  Type::PAD_GROUP_MODE = 47,
  Type::EVENT_LAST = 48
}
 Specifies the type of the event. More...
 
- Static Public Member Functions inherited from Gdk::Event
static void set_show_events (bool show_events)
 Sets whether a trace of received events is output. More...
 
static bool get_show_events ()
 Gets whether event debugging output is enabled. More...
 
static Event get ()
 Checks all open displays for a Gdk::Event to process,to be processed on, fetching events from the windowing system if necessary. More...
 
static Event peek ()
 If there is an event waiting in the event queue of some open display, returns a copy of it. More...
 
static bool events_pending ()
 Checks if any events are ready to be processed for any display. More...
 

Detailed Description

Generated when all or part of a window becomes visible and needs to be redrawn.

get_event_type() will return one of Gdk::Event::Type::EXPOSE, Gdk::Event::Type::DAMAGE.

Since gtkmm 3.90:

Constructor & Destructor Documentation

Gdk::EventExpose::EventExpose ( )

Creates an invalid event object.

Calling any member functions is undefined behavior.

Gdk::EventExpose::EventExpose ( GdkEventExpose *  gobject,
bool  make_a_copy = false 
)
explicit

Wraps a C event instance.

This constructor either acquires ownership of gobject, or copies it.

Parameters
gobjectEvent to wrap.
make_a_copyIf false, the ownership of gobject is acquired, otherwise, a copy is made.

Member Function Documentation

const Gdk::Rectangle& Gdk::EventExpose::get_area ( ) const

Returns the bounding box of the region to be redrawn.

int Gdk::EventExpose::get_count ( ) const

Returns the number of contiguous Gdk::Event::Type::EXPOSE events following this one.

The only use for this is "exposure compression", i.e. handling all contiguous Gdk::Event::Type::EXPOSE events in one go, though GDK performs some exposure compression so this is not normally needed.

::Cairo::RefPtr<const ::Cairo::Region> Gdk::EventExpose::get_region ( ) const

Returns the region to be redrawn.

GdkEventExpose* Gdk::EventExpose::gobj ( )
inline

Provides access to the underlying C instance.

const GdkEventExpose* Gdk::EventExpose::gobj ( ) const
inline

Provides access to the underlying C instance.

GdkEventExpose* Gdk::EventExpose::gobj_copy ( ) const

Provides access to the underlying C instance.

The caller is responsible for freeing it with gdk_event_free(). Use when directly setting fields in structs.

void Gdk::EventExpose::swap ( EventExpose other)
noexcept

Friends And Related Function Documentation

void swap ( EventExpose lhs,
EventExpose rhs 
)
related
Parameters
lhsThe left-hand side
rhsThe right-hand side
Gdk::EventExpose wrap ( GdkEventExpose *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy.
Returns
A C++ instance that wraps this C instance.
const EventExpose& wrap_event ( const GdkEventExpose *&  event)
related

Wraps a C event instance without making unnecessary copy when the ownership can not be acquired.

The event pointer must not be deleted until last usage of the returned instance. Note, that this requirement applies to the pointer itself, in addition to the object it is pointing to.

EventExpose& wrap_event ( GdkEventExpose *&  event)
related