487 lines
8.6 KiB
Markdown
487 lines
8.6 KiB
Markdown
---
|
||
id: "qpainter"
|
||
title: "QPainter"
|
||
sidebar_label: "QPainter"
|
||
---
|
||
|
||
> Lets you paint on widgets.
|
||
|
||
**This class is a JS wrapper around Qt's [QPainter class](https://doc.qt.io/qt-5/qpainter.html)**
|
||
|
||
Note: QPainter works only inside the paint event.
|
||
|
||
### Example
|
||
|
||
```javascript
|
||
|
||
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](component.md)
|
||
|
||
↳ **QPainter**
|
||
|
||
## Index
|
||
|
||
### Constructors
|
||
|
||
* [constructor](qpainter.md#constructor)
|
||
|
||
### Properties
|
||
|
||
* [native](qpainter.md#native)
|
||
* [nodeChildren](qpainter.md#nodechildren)
|
||
* [nodeParent](qpainter.md#optional-nodeparent)
|
||
|
||
### Methods
|
||
|
||
* [begin](qpainter.md#begin)
|
||
* [beginNativePainting](qpainter.md#beginnativepainting)
|
||
* [drawArc](qpainter.md#drawarc)
|
||
* [drawConvexPolygon](qpainter.md#drawconvexpolygon)
|
||
* [drawEllipse](qpainter.md#drawellipse)
|
||
* [drawImage](qpainter.md#drawimage)
|
||
* [drawLine](qpainter.md#drawline)
|
||
* [drawPath](qpainter.md#drawpath)
|
||
* [drawPie](qpainter.md#drawpie)
|
||
* [drawText](qpainter.md#drawtext)
|
||
* [end](qpainter.md#end)
|
||
* [endNativePainting](qpainter.md#endnativepainting)
|
||
* [fillRect](qpainter.md#fillrect)
|
||
* [restore](qpainter.md#restore)
|
||
* [rotate](qpainter.md#rotate)
|
||
* [save](qpainter.md#save)
|
||
* [scale](qpainter.md#scale)
|
||
* [setBrush](qpainter.md#setbrush)
|
||
* [setFont](qpainter.md#setfont)
|
||
* [setNodeParent](qpainter.md#setnodeparent)
|
||
* [setPen](qpainter.md#setpen)
|
||
* [setRenderHint](qpainter.md#setrenderhint)
|
||
* [setTransform](qpainter.md#settransform)
|
||
* [strokePath](qpainter.md#strokepath)
|
||
* [translate](qpainter.md#translate)
|
||
|
||
## Constructors
|
||
|
||
### constructor
|
||
|
||
\+ **new QPainter**(): *[QPainter](qpainter.md)*
|
||
|
||
*Overrides [Component](component.md).[constructor](component.md#constructor)*
|
||
|
||
**Returns:** *[QPainter](qpainter.md)*
|
||
|
||
\+ **new QPainter**(`device`: [Component](component.md)): *[QPainter](qpainter.md)*
|
||
|
||
*Overrides [Component](component.md).[constructor](component.md#constructor)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`device` | [Component](component.md) |
|
||
|
||
**Returns:** *[QPainter](qpainter.md)*
|
||
|
||
## Properties
|
||
|
||
### native
|
||
|
||
• **native**: *[NativeElement](../globals.md#nativeelement)*
|
||
|
||
*Overrides [Component](component.md).[native](component.md#abstract-native)*
|
||
|
||
___
|
||
|
||
### nodeChildren
|
||
|
||
• **nodeChildren**: *Set‹[Component](component.md)›*
|
||
|
||
*Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)*
|
||
|
||
___
|
||
|
||
### `Optional` nodeParent
|
||
|
||
• **nodeParent**? : *[Component](component.md)*
|
||
|
||
*Inherited from [Component](component.md).[nodeParent](component.md#optional-nodeparent)*
|
||
|
||
## Methods
|
||
|
||
### begin
|
||
|
||
▸ **begin**(`device`: [QWidget](qwidget.md) | [QImage](qimage.md)): *boolean*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`device` | [QWidget](qwidget.md) | [QImage](qimage.md) |
|
||
|
||
**Returns:** *boolean*
|
||
|
||
___
|
||
|
||
### beginNativePainting
|
||
|
||
▸ **beginNativePainting**(): *void*
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### drawArc
|
||
|
||
▸ **drawArc**(`x`: number, `y`: number, `width`: number, `height`: number, `startAngle`: number, `spanAngle`: number): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`x` | number |
|
||
`y` | number |
|
||
`width` | number |
|
||
`height` | number |
|
||
`startAngle` | number |
|
||
`spanAngle` | number |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### drawConvexPolygon
|
||
|
||
▸ **drawConvexPolygon**(`points`: [QPoint](qpoint.md)[]): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`points` | [QPoint](qpoint.md)[] |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### drawEllipse
|
||
|
||
▸ **drawEllipse**(`x`: number, `y`: number, `width`: number, `height`: number): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`x` | number |
|
||
`y` | number |
|
||
`width` | number |
|
||
`height` | number |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### drawImage
|
||
|
||
▸ **drawImage**(`x`: number, `y`: number, `image`: [QImage](qimage.md), `sx`: number, `sy`: number, `sw`: number, `sh`: number): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`x` | number | - |
|
||
`y` | number | - |
|
||
`image` | [QImage](qimage.md) | - |
|
||
`sx` | number | 0 |
|
||
`sy` | number | 0 |
|
||
`sw` | number | -1 |
|
||
`sh` | number | -1 |
|
||
|
||
**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](qpainterpath.md)): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`path` | [QPainterPath](qpainterpath.md) |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### drawPie
|
||
|
||
▸ **drawPie**(`x`: number, `y`: number, `width`: number, `height`: number, `startAngle`: number, `sweepLength`: number): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`x` | number |
|
||
`y` | number |
|
||
`width` | number |
|
||
`height` | number |
|
||
`startAngle` | number |
|
||
`sweepLength` | number |
|
||
|
||
**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*
|
||
|
||
___
|
||
|
||
### endNativePainting
|
||
|
||
▸ **endNativePainting**(): *void*
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### fillRect
|
||
|
||
▸ **fillRect**(`x`: number, `y`: number, `width`: number, `height`: number, `color`: [QColor](qcolor.md)): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`x` | number |
|
||
`y` | number |
|
||
`width` | number |
|
||
`height` | number |
|
||
`color` | [QColor](qcolor.md) |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### 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](qcolor.md)): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`color` | [QColor](qcolor.md) |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### setFont
|
||
|
||
▸ **setFont**(`font`: [QFont](qfont.md)): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`font` | [QFont](qfont.md) |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### setNodeParent
|
||
|
||
▸ **setNodeParent**(`parent?`: [Component](component.md)): *void*
|
||
|
||
*Inherited from [Component](component.md).[setNodeParent](component.md#setnodeparent)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`parent?` | [Component](component.md) |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### setPen
|
||
|
||
▸ **setPen**(`arg`: [PenStyle](../enums/penstyle.md) | [QColor](qcolor.md) | [QPen](qpen.md)): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`arg` | [PenStyle](../enums/penstyle.md) | [QColor](qcolor.md) | [QPen](qpen.md) |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### setRenderHint
|
||
|
||
▸ **setRenderHint**(`hint`: [RenderHint](../enums/renderhint.md), `on`: boolean): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`hint` | [RenderHint](../enums/renderhint.md) | - |
|
||
`on` | boolean | true |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### setTransform
|
||
|
||
▸ **setTransform**(`matrix2x3`: number[] | Float32Array, `combine`: boolean): *void*
|
||
|
||
Sets the world transformation matrix.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Default | Description |
|
||
------ | ------ | ------ | ------ |
|
||
`matrix2x3` | number[] | Float32Array | - | An array of length 6 representing a 2x3 transformation matrix. The order of elements corresponds to the convention used in QTransform, i.e. m11, m12, m21, m22, dx, and dy. |
|
||
`combine` | boolean | false | If set then this transform will be combining with the curent one. Otherwise it replaces it completely. |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### strokePath
|
||
|
||
▸ **strokePath**(`path`: [QPainterPath](qpainterpath.md), `pen`: [QPen](qpen.md)): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`path` | [QPainterPath](qpainterpath.md) |
|
||
`pen` | [QPen](qpen.md) |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### translate
|
||
|
||
▸ **translate**(`dx`: number, `dy`: number): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`dx` | number |
|
||
`dy` | number |
|
||
|
||
**Returns:** *void*
|