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

id	title	sidebar_label
qicon	QIcon	QIcon

The QIcon class provides scalable icons in different modes and states.

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

Example

const { QIcon } = require("@nodegui/nodegui");

const imageUrl = "path/to/png";
const icon = new QIcon(imageUrl);

Hierarchy

• Component

  ↳ QIcon

Index

Constructors

• constructor

Properties

• native
• nodeChildren
• nodeParent

Methods

• cacheKey
• isMask
• pixmap
• setIsMask
• setNodeParent
• fromQVariant

Constructors

constructor

+ new QIcon(): QIcon

Returns: QIcon

+ new QIcon(native: NativeElement): QIcon

Parameters:

Name	Type
native	NativeElement

Returns: QIcon

+ new QIcon(filePath: string): QIcon

Parameters:

Name	Type
filePath	string

Returns: QIcon

Properties

native

• native: NativeElement

Overrides Component.native

---

nodeChildren

• nodeChildren: Set‹unknown› = new Set()

Inherited from Component.nodeChildren

---

Optional nodeParent

• nodeParent? : Component

Inherited from Component.nodeParent

Methods

cacheKey

▸ cacheKey(): number

Returns: number

---

isMask

▸ isMask(): boolean

Returns: boolean

---

pixmap

▸ pixmap(width: number, height: number, mode?: QIconMode, state?: QIconState): QPixmap

Parameters:

Name	Type
width	number
height	number
mode?	QIconMode
state?	QIconState

Returns: QPixmap

---

setIsMask

▸ setIsMask(isMask: boolean): void

Parameters:

Name	Type
isMask	boolean

Returns: void

---

setNodeParent

▸ setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

Name	Type
parent?	Component

Returns: void

---

Static fromQVariant

▸ fromQVariant(variant: QVariant): QIcon

Parameters:

Name	Type
variant	QVariant

Returns: QIcon