RNAction

Hierarchy

• QAction

  ↳ RNAction

Implements

• RNComponent

Index

Constructors

• constructor

Properties

• icon
• menu
• native
• nodeChildren
• nodeParent
• tagName

Methods

• addEventListener
• appendChild
• appendInitialChild
• data
• eventProcessed
• font
• inherits
• insertBefore
• isCheckable
• isChecked
• isSeparator
• objectName
• property
• removeChild
• removeEventListener
• setCheckable
• setChecked
• setData
• setEnabled
• setEventProcessed
• setFont
• setIcon
• setMenu
• setNodeParent
• setObjectName
• setProperty
• setProps
• setSeparator
• setShortcut
• setShortcutContext
• setText

Constructors

constructor

+ new RNAction(): RNAction

Inherited from RNAction.constructor

Overrides void

Returns: RNAction

+ new RNAction(native: NativeElement): RNAction

Inherited from RNAction.constructor

Overrides void

Parameters:

Name	Type
native	NativeElement

Returns: RNAction

+ new RNAction(parent: NodeWidget‹any›): RNAction

Inherited from RNAction.constructor

Overrides void

Parameters:

Name	Type
parent	NodeWidget‹any›

Returns: RNAction

Properties

Optional icon

• icon? : QIcon

Inherited from RNAction.icon

---

Optional menu

• menu? : QMenu

Inherited from RNAction.menu

---

native

• native: NativeElement

Inherited from RNAction.native

Overrides void

---

nodeChildren

• nodeChildren: Set‹Component›

Inherited from RNAction.nodeChildren

---

Optional nodeParent

• nodeParent? : Component

Inherited from RNAction.nodeParent

---

Static tagName

▪ tagName: string = "action"

Methods

addEventListener

▸ addEventListener‹SignalType›(signalType: SignalType, callback: QActionSignals[SignalType]): void

Inherited from RNAction.addEventListener

Type parameters:

▪ SignalType: keyof QActionSignals

Parameters:

Name	Type	Description
signalType	SignalType	SignalType is a signal from the widgets signals interface.
callback	QActionSignals[SignalType]	Corresponding callback for the signal as mentioned in the widget's signal interface

Returns: void

void

For example in the case of QPushButton:

const button = new QPushButton();

button.addEventListener('clicked',(checked)=>console.log("clicked"));

// here clicked is a value from QPushButtonSignals interface

▸ addEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from RNAction.addEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

For example in the case of QPushButton:

const button = new QPushButton();

button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

appendChild

▸ appendChild(child: Component): void

Parameters:

Name	Type
child	Component

Returns: void

---

appendInitialChild

▸ appendInitialChild(child: Component): void

Parameters:

Name	Type
child	Component

Returns: void

---

data

▸ data(): QVariant

Inherited from RNAction.data

Returns: QVariant

---

eventProcessed

▸ eventProcessed(): boolean

Inherited from RNAction.eventProcessed

Get the state of the event processed flag

See setEventProcessed().

Returns: boolean

boolean True if the current event is flagged as processed.

---

font

▸ font(): QFont

Inherited from RNAction.font

Returns: QFont

---

inherits

▸ inherits(className: string): boolean

Inherited from RNAction.inherits

Parameters:

Name	Type
className	string

Returns: boolean

---

insertBefore

▸ insertBefore(child: Component, beforeChild: Component): void

Parameters:

Name	Type
child	Component
beforeChild	Component

Returns: void

---

isCheckable

▸ isCheckable(): boolean

Inherited from RNAction.isCheckable

Returns: boolean

---

isChecked

▸ isChecked(): boolean

Inherited from RNAction.isChecked

Returns: boolean

---

isSeparator

▸ isSeparator(): boolean

Inherited from RNAction.isSeparator

Returns: boolean

---

objectName

▸ objectName(): string

Inherited from RNAction.objectName

Returns: string

---

property

▸ property(name: string): QVariant

Inherited from RNAction.property

Parameters:

Name	Type
name	string

Returns: QVariant

---

removeChild

▸ removeChild(child: Component): void

Parameters:

Name	Type
child	Component

Returns: void

---

removeEventListener

▸ removeEventListener‹SignalType›(signalType: SignalType, callback: QActionSignals[SignalType]): void

Inherited from RNAction.removeEventListener

Type parameters:

▪ SignalType: keyof QActionSignals

Parameters:

Name	Type
signalType	SignalType
callback	QActionSignals[SignalType]

Returns: void

▸ removeEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from RNAction.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

setCheckable

▸ setCheckable(isCheckable: boolean): void

Inherited from RNAction.setCheckable

Parameters:

Name	Type
isCheckable	boolean

Returns: void

---

setChecked

▸ setChecked(isChecked: boolean): void

Inherited from RNAction.setChecked

Parameters:

Name	Type
isChecked	boolean

Returns: void

---

setData

▸ setData(value: QVariant): void

Inherited from RNAction.setData

Parameters:

Name	Type
value	QVariant

Returns: void

---

setEnabled

▸ setEnabled(enabled: boolean): void

Inherited from RNAction.setEnabled

Parameters:

Name	Type
enabled	boolean

Returns: void

---

setEventProcessed

▸ setEventProcessed(isProcessed: boolean): void

Inherited from RNAction.setEventProcessed

Mark the current event as having been processed

This method is used to indicate that the currently dispatched event has been processed and no further processing by superclasses is required. It only makes sense to call this method from an event handler.

When set, this flag will cause NodeGui's QObject::event() method to return true and not call the superclass event(), effectively preventing any further processing on this event.

Parameters:

Name	Type	Description
isProcessed	boolean	true if the event has been processed.

Returns: void

---

setFont

▸ setFont(font: QFont): void

Inherited from RNAction.setFont

Parameters:

Name	Type
font	QFont

Returns: void

---

setIcon

▸ setIcon(icon: QIcon): void

Inherited from RNAction.setIcon

Parameters:

Name	Type
icon	QIcon

Returns: void

---

setMenu

▸ setMenu(menu: QMenu): void

Inherited from RNAction.setMenu

Parameters:

Name	Type
menu	QMenu

Returns: void

---

setNodeParent

▸ setNodeParent(parent?: Component): void

Inherited from RNAction.setNodeParent

Parameters:

Name	Type
parent?	Component

Returns: void

---

setObjectName

▸ setObjectName(objectName: string): void

Inherited from RNAction.setObjectName

Parameters:

Name	Type
objectName	string

Returns: void

---

setProperty

▸ setProperty(name: string, value: QVariantType): boolean

Inherited from RNAction.setProperty

Parameters:

Name	Type
name	string
value	QVariantType

Returns: boolean

---

setProps

▸ setProps(newProps: ActionProps, oldProps: ActionProps): void

Parameters:

Name	Type
newProps	ActionProps
oldProps	ActionProps

Returns: void

---

setSeparator

▸ setSeparator(isSeparator: boolean): void

Inherited from RNAction.setSeparator

Parameters:

Name	Type
isSeparator	boolean

Returns: void

---

setShortcut

▸ setShortcut(keysequence: QKeySequence): void

Inherited from RNAction.setShortcut

Parameters:

Name	Type
keysequence	QKeySequence

Returns: void

---

setShortcutContext

▸ setShortcutContext(shortcutContext: ShortcutContext): void

Inherited from RNAction.setShortcutContext

Parameters:

Name	Type
shortcutContext	ShortcutContext

Returns: void

---

setText

▸ setText(text: string): void

Inherited from RNAction.setText

Parameters:

Name	Type
text	string

Returns: void