Qt 4.8
Public Functions | Protected Variables | Friends | List of all members
QPaintEvent Class Reference

The QPaintEvent class contains event parameters for paint events. More...

#include <qevent.h>

Inheritance diagram for QPaintEvent:
QEvent

Public Functions

 QPaintEvent (const QRegion &paintRegion)
 Constructs a paint event object with the region that needs to be updated. More...
 
 QPaintEvent (const QRect &paintRect)
 Constructs a paint event object with the rectangle that needs to be updated. More...
 
const QRectrect () const
 Returns the rectangle that needs to be updated. More...
 
const QRegionregion () const
 Returns the region that needs to be updated. More...
 
 ~QPaintEvent ()
 
- Public Functions inherited from QEvent
void accept ()
 Sets the accept flag of the event object, the equivalent of calling setAccepted(true). More...
 
void ignore ()
 Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false). More...
 
bool isAccepted () const
 
 QEvent (Type type)
 Contructs an event object of type type. More...
 
void setAccepted (bool accepted)
 
bool spontaneous () const
 Returns true if the event originated outside the application (a system event); otherwise returns false. More...
 
Type type () const
 Returns the event type. More...
 
virtual ~QEvent ()
 Destroys the event. More...
 

Protected Variables

bool m_erased
 
QRect m_rect
 
QRegion m_region
 
- Protected Variables inherited from QEvent
QEventPrivate * d
 
ushort t
 

Friends

class QApplication
 
class QCoreApplication
 

Additional Inherited Members

- Public Types inherited from QEvent
enum  Type {
  None = 0, Timer = 1, MouseButtonPress = 2, MouseButtonRelease = 3,
  MouseButtonDblClick = 4, MouseMove = 5, KeyPress = 6, KeyRelease = 7,
  FocusIn = 8, FocusOut = 9, Enter = 10, Leave = 11,
  Paint = 12, Move = 13, Resize = 14, Create = 15,
  Destroy = 16, Show = 17, Hide = 18, Close = 19,
  Quit = 20, ParentChange = 21, ParentAboutToChange = 131, ThreadChange = 22,
  WindowActivate = 24, WindowDeactivate = 25, ShowToParent = 26, HideToParent = 27,
  Wheel = 31, WindowTitleChange = 33, WindowIconChange = 34, ApplicationWindowIconChange = 35,
  ApplicationFontChange = 36, ApplicationLayoutDirectionChange = 37, ApplicationPaletteChange = 38, PaletteChange = 39,
  Clipboard = 40, Speech = 42, MetaCall = 43, SockAct = 50,
  WinEventAct = 132, DeferredDelete = 52, DragEnter = 60, DragMove = 61,
  DragLeave = 62, Drop = 63, DragResponse = 64, ChildAdded = 68,
  ChildPolished = 69, ChildRemoved = 71, ShowWindowRequest = 73, PolishRequest = 74,
  Polish = 75, LayoutRequest = 76, UpdateRequest = 77, UpdateLater = 78,
  EmbeddingControl = 79, ActivateControl = 80, DeactivateControl = 81, ContextMenu = 82,
  InputMethod = 83, AccessibilityPrepare = 86, TabletMove = 87, LocaleChange = 88,
  LanguageChange = 89, LayoutDirectionChange = 90, Style = 91, TabletPress = 92,
  TabletRelease = 93, OkRequest = 94, HelpRequest = 95, IconDrag = 96,
  FontChange = 97, EnabledChange = 98, ActivationChange = 99, StyleChange = 100,
  IconTextChange = 101, ModifiedChange = 102, MouseTrackingChange = 109, WindowBlocked = 103,
  WindowUnblocked = 104, WindowStateChange = 105, ToolTip = 110, WhatsThis = 111,
  StatusTip = 112, ActionChanged = 113, ActionAdded = 114, ActionRemoved = 115,
  FileOpen = 116, Shortcut = 117, ShortcutOverride = 51, WhatsThisClicked = 118,
  ToolBarChange = 120, ApplicationActivate = 121, ApplicationActivated = ApplicationActivate, ApplicationDeactivate = 122,
  ApplicationDeactivated = ApplicationDeactivate, QueryWhatsThis = 123, EnterWhatsThisMode = 124, LeaveWhatsThisMode = 125,
  ZOrderChange = 126, HoverEnter = 127, HoverLeave = 128, HoverMove = 129,
  AccessibilityHelp = 119, AccessibilityDescription = 130, AcceptDropsChange = 152, MenubarUpdated = 153,
  ZeroTimerEvent = 154, GraphicsSceneMouseMove = 155, GraphicsSceneMousePress = 156, GraphicsSceneMouseRelease = 157,
  GraphicsSceneMouseDoubleClick = 158, GraphicsSceneContextMenu = 159, GraphicsSceneHoverEnter = 160, GraphicsSceneHoverMove = 161,
  GraphicsSceneHoverLeave = 162, GraphicsSceneHelp = 163, GraphicsSceneDragEnter = 164, GraphicsSceneDragMove = 165,
  GraphicsSceneDragLeave = 166, GraphicsSceneDrop = 167, GraphicsSceneWheel = 168, KeyboardLayoutChange = 169,
  DynamicPropertyChange = 170, TabletEnterProximity = 171, TabletLeaveProximity = 172, NonClientAreaMouseMove = 173,
  NonClientAreaMouseButtonPress = 174, NonClientAreaMouseButtonRelease = 175, NonClientAreaMouseButtonDblClick = 176, MacSizeChange = 177,
  ContentsRectChange = 178, MacGLWindowChange = 179, FutureCallOut = 180, GraphicsSceneResize = 181,
  GraphicsSceneMove = 182, CursorChange = 183, ToolTipChange = 184, NetworkReplyUpdated = 185,
  GrabMouse = 186, UngrabMouse = 187, GrabKeyboard = 188, UngrabKeyboard = 189,
  MacGLClearDrawable = 191, StateMachineSignal = 192, StateMachineWrapped = 193, TouchBegin = 194,
  TouchUpdate = 195, TouchEnd = 196, NativeGesture = 197, RequestSoftwareInputPanel = 199,
  CloseSoftwareInputPanel = 200, UpdateSoftKeys = 201, WinIdChange = 203, Gesture = 198,
  GestureOverride = 202, PlatformPanel = 212, User = 1000, MaxUser = 65535
}
 This enum type defines the valid event types in Qt. More...
 
- Static Public Functions inherited from QEvent
static int registerEventType (int hint=-1)
 Registers and returns a custom event type. More...
 

Detailed Description

The QPaintEvent class contains event parameters for paint events.

Paint events are sent to widgets that need to update themselves, for instance when part of a widget is exposed because a covering widget was moved.

The event contains a region() that needs to be updated, and a rect() that is the bounding rectangle of that region. Both are provided because many widgets can't make much use of region(), and rect() can be much faster than region().boundingRect().

Automatic Clipping

Painting is clipped to region() during the processing of a paint event. This clipping is performed by Qt's paint system and is independent of any clipping that may be applied to a QPainter used to draw on the paint device.

As a result, the value returned by QPainter::clipRegion() on a newly-constructed QPainter will not reflect the clip region that is used by the paint system.

See also
QPainter, QWidget::update(), QWidget::repaint(), QWidget::paintEvent()

Definition at line 298 of file qevent.h.

Constructors and Destructors

◆ QPaintEvent() [1/2]

QPaintEvent::QPaintEvent ( const QRegion paintRegion)

Constructs a paint event object with the region that needs to be updated.

The region is specified by paintRegion.

Definition at line 1311 of file qevent.cpp.

Referenced by QPaintEvent().

1312  : QEvent(Paint), m_rect(paintRegion.boundingRect()), m_region(paintRegion), m_erased(false)
1313 {}
QRect boundingRect() const
Returns the bounding rectangle of this region.
Definition: qregion.cpp:4363
QEvent(Type type)
Contructs an event object of type type.
Definition: qcoreevent.cpp:289
bool m_erased
Definition: qevent.h:319
QRect m_rect
Definition: qevent.h:317
QRegion m_region
Definition: qevent.h:318

◆ QPaintEvent() [2/2]

QPaintEvent::QPaintEvent ( const QRect paintRect)

Constructs a paint event object with the rectangle that needs to be updated.

The region is specified by paintRect.

Definition at line 1319 of file qevent.cpp.

1320  : QEvent(Paint), m_rect(paintRect),m_region(paintRect), m_erased(false)
1321 {}
QEvent(Type type)
Contructs an event object of type type.
Definition: qcoreevent.cpp:289
bool m_erased
Definition: qevent.h:319
QRect m_rect
Definition: qevent.h:317
QRegion m_region
Definition: qevent.h:318

◆ ~QPaintEvent()

QPaintEvent::~QPaintEvent ( )
Warning
This function is not part of the public interface.

Definition at line 1339 of file qevent.cpp.

1340 {
1341 }

Functions

◆ rect()

const QRect & QPaintEvent::rect ( ) const
inline

◆ region()

const QRegion & QPaintEvent::region ( ) const
inline

Returns the region that needs to be updated.

See also
rect() QPainter::setClipRegion()

Definition at line 306 of file qevent.h.

Referenced by QMdiArea::paintEvent(), and QTreeView::paintEvent().

306 { return m_region; }
QRegion m_region
Definition: qevent.h:318

Friends and Related Functions

◆ QApplication

friend class QApplication
friend

Definition at line 315 of file qevent.h.

◆ QCoreApplication

friend class QCoreApplication
friend

Definition at line 316 of file qevent.h.

Properties

◆ m_erased

bool QPaintEvent::m_erased
protected

Definition at line 319 of file qevent.h.

Referenced by QPaintEvent().

◆ m_rect

QRect QPaintEvent::m_rect
protected

Definition at line 317 of file qevent.h.

Referenced by QPaintEvent().

◆ m_region

QRegion QPaintEvent::m_region
protected

Definition at line 318 of file qevent.h.

Referenced by QPaintEvent().


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