nodeguy/website/docs/api/generated/classes/qpainter.md

id	title	sidebar_label
qpainter	QPainter	QPainter

Lets you paint on widgets.

This class is a JS wrapper around Qt's QPainter class

Note: QPainter works only inside the paint event.

Example

import { FlexLayout, WidgetEventTypes, QMainWindow, QPainter, QWidget } from '@nodegui/nodegui';

const win = new QMainWindow();
const center = new QWidget();
const layout = new FlexLayout();
center.setLayout(layout);
win.resize(200, 200);

win.addEventListener(WidgetEventTypes.Paint, () => {
const painter = new QPainter(win);
painter.drawText(20, 20, 'Hello');
painter.end();
});
win.show();
(global as any).win = win;

Advanced example:

https://github.com/nodegui/examples/blob/master/nodegui/custom-native-widget-qpainter

Hierarchy

• Component

  ↳ QPainter

Index

Constructors

• constructor

Properties

• native
• nodeChildren
• nodeParent

Methods

• begin
• drawConvexPolygon
• drawLine
• drawPath
• drawText
• end
• restore
• rotate
• save
• scale
• setBrush
• setNodeParent
• setPen
• setRenderHint
• strokePath
• translate

Constructors

constructor

+ new QPainter(): QPainter

Overrides Component.constructor

Returns: QPainter

+ new QPainter(device: Component): QPainter

Overrides Component.constructor

Parameters:

Name	Type
device	Component

Returns: QPainter

Properties

native

• native: NativeElement

Overrides Component.native

---

nodeChildren

• nodeChildren: Set‹Component›

Inherited from Component.nodeChildren

---

Optional nodeParent

• nodeParent? : Component

Inherited from Component.nodeParent

Methods

begin

▸ begin(device: Component): boolean

Parameters:

Name	Type
device	Component

Returns: boolean

---

drawConvexPolygon

▸ drawConvexPolygon(points: QPoint[]): void

Parameters:

Name	Type
points	QPoint[]

Returns: void

---

drawLine

▸ drawLine(x1: number, y1: number, x2: number, y2: number): void

Parameters:

Name	Type
x1	number
y1	number
x2	number
y2	number

Returns: void

---

drawPath

▸ drawPath(path: QPainterPath): void

Parameters:

Name	Type
path	QPainterPath

Returns: void

---

drawText

▸ drawText(x: number, y: number, text: string): void

Parameters:

Name	Type
x	number
y	number
text	string

Returns: void

---

end

▸ end(): boolean

Returns: boolean

---

restore

▸ restore(): void

Returns: void

---

rotate

▸ rotate(angle: number): void

Parameters:

Name	Type
angle	number

Returns: void

---

save

▸ save(): void

Returns: void

---

scale

▸ scale(sx: number, sy: number): void

Parameters:

Name	Type
sx	number
sy	number

Returns: void

---

setBrush

▸ setBrush(color: QColor): void

Parameters:

Name	Type
color	QColor

Returns: void

---

setNodeParent

▸ setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

Name	Type
parent?	Component

Returns: void

---

setPen

▸ setPen(arg: PenStyle | QColor | QPen): void

Parameters:

Name	Type
arg	PenStyle | QColor | QPen

Returns: void

---

setRenderHint

▸ setRenderHint(hint: RenderHint, on: boolean): void

Parameters:

Name	Type	Default
hint	RenderHint	-
on	boolean	true

Returns: void

---

strokePath

▸ strokePath(path: QPainterPath, pen: QPen): void

Parameters:

Name	Type
path	QPainterPath
pen	QPen

Returns: void

---

translate

▸ translate(dx: number, dy: number): void

Parameters:

Name	Type
dx	number
dy	number

Returns: void