nodeguy/38bb4e1a.6859c262.js
2022-05-27 16:19:15 +00:00

1 line
56 KiB
JavaScript

(window.webpackJsonp=window.webpackJsonp||[]).push([[101],{159:function(e,t,a){"use strict";a.r(t),a.d(t,"frontMatter",(function(){return c})),a.d(t,"metadata",(function(){return l})),a.d(t,"rightToc",(function(){return p})),a.d(t,"default",(function(){return j}));var b=a(2),n=a(6),r=(a(0),a(467)),c={id:"qlayout",title:"QLayout",sidebar_label:"QLayout"},l={unversionedId:"api/generated/classes/qlayout",id:"api/generated/classes/qlayout",isDocsHomePage:!1,title:"QLayout",description:"Abstract class to add functionalities common to all Layout.",source:"@site/docs/api/generated/classes/qlayout.md",slug:"/api/generated/classes/qlayout",permalink:"/docs/api/generated/classes/qlayout",editUrl:"https://github.com/nodegui/nodegui/edit/master/website/docs/api/generated/classes/qlayout.md",version:"current",sidebar_label:"QLayout",sidebar:"api",previous:{title:"QLabel",permalink:"/docs/api/generated/classes/qlabel"},next:{title:"QLineEdit",permalink:"/docs/api/generated/classes/qlineedit"}},p=[{value:"Example",id:"example",children:[]},{value:"Type parameters",id:"type-parameters",children:[]},{value:"Hierarchy",id:"hierarchy",children:[]},{value:"Index",id:"index",children:[{value:"Constructors",id:"constructors",children:[]},{value:"Properties",id:"properties",children:[]},{value:"Methods",id:"methods",children:[]}]},{value:"Constructors",id:"constructors-1",children:[{value:"constructor",id:"constructor",children:[]}]},{value:"Properties",id:"properties-1",children:[{value:"native",id:"native",children:[]},{value:"type",id:"type",children:[]}]},{value:"Methods",id:"methods-1",children:[{value:"_id",id:"_id",children:[]},{value:"activate",id:"activate",children:[]},{value:"addEventListener",id:"addeventlistener",children:[]},{value:"<code>Abstract</code> addWidget",id:"abstract-addwidget",children:[]},{value:"children",id:"children",children:[]},{value:"delete",id:"delete",children:[]},{value:"deleteLater",id:"deletelater",children:[]},{value:"dumpObjectInfo",id:"dumpobjectinfo",children:[]},{value:"dumpObjectTree",id:"dumpobjecttree",children:[]},{value:"eventProcessed",id:"eventprocessed",children:[]},{value:"inherits",id:"inherits",children:[]},{value:"invalidate",id:"invalidate",children:[]},{value:"isEnabled",id:"isenabled",children:[]},{value:"killTimer",id:"killtimer",children:[]},{value:"objectName",id:"objectname",children:[]},{value:"parent",id:"parent",children:[]},{value:"property",id:"property",children:[]},{value:"removeEventListener",id:"removeeventlistener",children:[]},{value:"<code>Abstract</code> removeWidget",id:"abstract-removewidget",children:[]},{value:"setContentsMargins",id:"setcontentsmargins",children:[]},{value:"setEnabled",id:"setenabled",children:[]},{value:"setEventProcessed",id:"seteventprocessed",children:[]},{value:"setObjectName",id:"setobjectname",children:[]},{value:"setParent",id:"setparent",children:[]},{value:"setProperty",id:"setproperty",children:[]},{value:"setSizeConstraint",id:"setsizeconstraint",children:[]},{value:"setSpacing",id:"setspacing",children:[]},{value:"sizeConstraint",id:"sizeconstraint",children:[]},{value:"spacing",id:"spacing",children:[]},{value:"startTimer",id:"starttimer",children:[]},{value:"update",id:"update",children:[]}]}],i={rightToc:p};function j(e){var t=e.components,a=Object(n.a)(e,["components"]);return Object(r.b)("wrapper",Object(b.a)({},i,a,{components:t,mdxType:"MDXLayout"}),Object(r.b)("blockquote",null,Object(r.b)("p",{parentName:"blockquote"},"Abstract class to add functionalities common to all Layout.")),Object(r.b)("p",null,"*This class implements all methods, properties of Qt's ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"https://doc.qt.io/qt-5/qlayout.html"}),"QLayout class")," so that it can be inherited by all layouts**"),Object(r.b)("p",null,Object(r.b)("inlineCode",{parentName:"p"},"QLayout")," is an abstract class and hence no instances of the same should be created."),Object(r.b)("h3",{id:"example"},"Example"),Object(r.b)("pre",null,Object(r.b)("code",Object(b.a)({parentName:"pre"},{className:"language-javascript"}),'const {\nQLayout,\nFlexLayout,\nGridLayout,\nQPushButton,\nQWidget\n} = require("@nodegui/nodegui");\n\n// addChildToLayout can accept any layout since it expects QLayout\nconst addChildToLayout = (layout: QLayout, widget: QWidget) => {\nlayout.addWidget(widget);\n};\n\naddChildToLayout(new FlexLayout(), new QPushButton());\naddChildToLayout(new GridLayout(), new QWidget());\n')),Object(r.b)("h2",{id:"type-parameters"},"Type parameters"),Object(r.b)("p",null,"\u25aa ",Object(r.b)("strong",{parentName:"p"},"Signals"),": ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/globals#qlayoutsignals"}),"QLayoutSignals"))),Object(r.b)("h2",{id:"hierarchy"},"Hierarchy"),Object(r.b)("p",null," \u21b3 ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),"\u2039Signals\u203a"),Object(r.b)("p",null," \u21b3 ",Object(r.b)("strong",{parentName:"p"},"QLayout")),Object(r.b)("p",null," \u21b3 ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/classes/flexlayout"}),"FlexLayout")),Object(r.b)("p",null," \u21b3 ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/classes/qboxlayout"}),"QBoxLayout")),Object(r.b)("p",null," \u21b3 ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/classes/qgridlayout"}),"QGridLayout")),Object(r.b)("h2",{id:"index"},"Index"),Object(r.b)("h3",{id:"constructors"},"Constructors"),Object(r.b)("ul",null,Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#constructor"}),"constructor"))),Object(r.b)("h3",{id:"properties"},"Properties"),Object(r.b)("ul",null,Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#native"}),"native")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#type"}),"type"))),Object(r.b)("h3",{id:"methods"},"Methods"),Object(r.b)("ul",null,Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#_id"}),"_id")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#activate"}),"activate")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#addeventlistener"}),"addEventListener")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#abstract-addwidget"}),"addWidget")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#children"}),"children")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#delete"}),"delete")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#deletelater"}),"deleteLater")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#dumpobjectinfo"}),"dumpObjectInfo")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#dumpobjecttree"}),"dumpObjectTree")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#eventprocessed"}),"eventProcessed")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#inherits"}),"inherits")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#invalidate"}),"invalidate")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#isenabled"}),"isEnabled")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#killtimer"}),"killTimer")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#objectname"}),"objectName")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#parent"}),"parent")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#property"}),"property")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#removeeventlistener"}),"removeEventListener")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#abstract-removewidget"}),"removeWidget")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#setcontentsmargins"}),"setContentsMargins")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#setenabled"}),"setEnabled")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#seteventprocessed"}),"setEventProcessed")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#setobjectname"}),"setObjectName")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#setparent"}),"setParent")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#setproperty"}),"setProperty")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#setsizeconstraint"}),"setSizeConstraint")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#setspacing"}),"setSpacing")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#sizeconstraint"}),"sizeConstraint")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#spacing"}),"spacing")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#starttimer"}),"startTimer")),Object(r.b)("li",{parentName:"ul"},Object(r.b)("a",Object(b.a)({parentName:"li"},{href:"/docs/api/generated/classes/qlayout#update"}),"update"))),Object(r.b)("h2",{id:"constructors-1"},"Constructors"),Object(r.b)("h3",{id:"constructor"},"constructor"),Object(r.b)("p",null,"+"," ",Object(r.b)("strong",{parentName:"p"},"new QLayout"),"(",Object(r.b)("inlineCode",{parentName:"p"},"nativeElementOrParent?"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/globals#nativeelement"}),"NativeElement")," | ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),"): ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qlayout"}),"QLayout"))),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#constructor"}),"constructor"))),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Overrides ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget"}),"EventWidget"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget#constructor"}),"constructor"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"nativeElementOrParent?")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/globals#nativeelement"}),"NativeElement")," ","|"," ",Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/classes/qobject"}),"QObject"))))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qlayout"}),"QLayout"))),Object(r.b)("h2",{id:"properties-1"},"Properties"),Object(r.b)("h3",{id:"native"},"native"),Object(r.b)("p",null,"\u2022 ",Object(r.b)("strong",{parentName:"p"},"native"),": ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/globals#nativeelement"}),"NativeElement")," | null")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/component"}),"Component"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/component#native"}),"native"))),Object(r.b)("hr",null),Object(r.b)("h3",{id:"type"},"type"),Object(r.b)("p",null,"\u2022 ",Object(r.b)("strong",{parentName:"p"},"type"),": ",Object(r.b)("em",{parentName:"p"},"string"),' = "layout"'),Object(r.b)("h2",{id:"methods-1"},"Methods"),Object(r.b)("h3",{id:"_id"},"_id"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"_id"),"(): ",Object(r.b)("em",{parentName:"p"},"number")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#_id"}),"_id"))),Object(r.b)("p",null,"Get an ID identifying the underlying C++ object."),Object(r.b)("p",null,"This can be useful when debugging memory problems with help from\n",Object(r.b)("inlineCode",{parentName:"p"},"setLogCreateQObject()")," and ",Object(r.b)("inlineCode",{parentName:"p"},"setLogDestroyQObject()"),". The number is\nhash of the memory address of the C++ object."),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"number")),Object(r.b)("p",null,"a unique number which is valid for the lifetime of the C++ object."),Object(r.b)("hr",null),Object(r.b)("h3",{id:"activate"},"activate"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"activate"),"(): ",Object(r.b)("em",{parentName:"p"},"boolean")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"boolean")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"addeventlistener"},"addEventListener"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"addEventListener"),"\u2039",Object(r.b)("strong",{parentName:"p"},"SignalType"),"\u203a(",Object(r.b)("inlineCode",{parentName:"p"},"signalType"),": SignalType, ",Object(r.b)("inlineCode",{parentName:"p"},"callback"),": Signals","[SignalType]",", ",Object(r.b)("inlineCode",{parentName:"p"},"options?"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/interfaces/eventlisteneroptions"}),"EventListenerOptions"),"): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget"}),"EventWidget"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget#addeventlistener"}),"addEventListener"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Type parameters:")),Object(r.b)("p",null,"\u25aa ",Object(r.b)("strong",{parentName:"p"},"SignalType"),": ",Object(r.b)("em",{parentName:"p"},"keyof Signals")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Description"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"signalType")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"SignalType"),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"SignalType is a signal from the widgets signals interface.")),Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"callback")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"Signals","[SignalType]"),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"Corresponding callback for the signal as mentioned in the widget's signal interface")),Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"options?")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/interfaces/eventlisteneroptions"}),"EventListenerOptions")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"Extra optional options controlling how this event listener is added.")))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,"void"),Object(r.b)("p",null,"For example in the case of QPushButton:"),Object(r.b)("pre",null,Object(r.b)("code",Object(b.a)({parentName:"pre"},{className:"language-js"}),"const button = new QPushButton();\nbutton.addEventListener('clicked',(checked)=>console.log(\"clicked\"));\n// here clicked is a value from QPushButtonSignals interface\n")),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"addEventListener"),"(",Object(r.b)("inlineCode",{parentName:"p"},"eventType"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/enums/widgeteventtypes"}),"WidgetEventTypes"),", ",Object(r.b)("inlineCode",{parentName:"p"},"callback"),": function, ",Object(r.b)("inlineCode",{parentName:"p"},"options?"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/interfaces/eventlisteneroptions"}),"EventListenerOptions"),"): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget"}),"EventWidget"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget#addeventlistener"}),"addEventListener"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("p",null,"\u25aa ",Object(r.b)("strong",{parentName:"p"},"eventType"),": ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/enums/widgeteventtypes"}),"WidgetEventTypes"))),Object(r.b)("p",null,"\u25aa ",Object(r.b)("strong",{parentName:"p"},"callback"),": ",Object(r.b)("em",{parentName:"p"},"function")),Object(r.b)("p",null,"\u25b8 (",Object(r.b)("inlineCode",{parentName:"p"},"event?"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/globals#nativerawpointer"}),"NativeRawPointer"),'\u2039"QEvent"\u203a): ',Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"event?")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/globals#nativerawpointer"}),"NativeRawPointer"),'\u2039"QEvent"\u203a')))),Object(r.b)("p",null,"\u25aa",Object(r.b)("inlineCode",{parentName:"p"},"Optional")," ",Object(r.b)("strong",{parentName:"p"},"options"),": ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/interfaces/eventlisteneroptions"}),"EventListenerOptions"))),Object(r.b)("p",null,"Extra optional options controlling how this event listener is added."),Object(r.b)("p",null,"For example in the case of QPushButton:"),Object(r.b)("pre",null,Object(r.b)("code",Object(b.a)({parentName:"pre"},{className:"language-js"}),'const button = new QPushButton();\nbutton.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));\n')),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"abstract-addwidget"},Object(r.b)("inlineCode",{parentName:"h3"},"Abstract")," addWidget"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"addWidget"),"(",Object(r.b)("inlineCode",{parentName:"p"},"childWidget"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/classes/qwidget"}),"QWidget"),", ...",Object(r.b)("inlineCode",{parentName:"p"},"args"),": any[]): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"childWidget")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/classes/qwidget"}),"QWidget"))),Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"...args")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"any[]")))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"children"},"children"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"children"),"(): ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),"[]")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#children"}),"children"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),"[]")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"delete"},"delete"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"delete"),"(): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#delete"}),"delete"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"deletelater"},"deleteLater"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"deleteLater"),"(): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#deletelater"}),"deleteLater"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"dumpobjectinfo"},"dumpObjectInfo"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"dumpObjectInfo"),"(): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#dumpobjectinfo"}),"dumpObjectInfo"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"dumpobjecttree"},"dumpObjectTree"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"dumpObjectTree"),"(): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#dumpobjecttree"}),"dumpObjectTree"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"eventprocessed"},"eventProcessed"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"eventProcessed"),"(): ",Object(r.b)("em",{parentName:"p"},"boolean")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget"}),"EventWidget"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget#eventprocessed"}),"eventProcessed"))),Object(r.b)("p",null,"Get the state of the event processed flag"),Object(r.b)("p",null,"See ",Object(r.b)("inlineCode",{parentName:"p"},"setEventProcessed()"),"."),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"boolean")),Object(r.b)("p",null,"boolean True if the current event is flagged as processed."),Object(r.b)("hr",null),Object(r.b)("h3",{id:"inherits"},"inherits"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"inherits"),"(",Object(r.b)("inlineCode",{parentName:"p"},"className"),": string): ",Object(r.b)("em",{parentName:"p"},"boolean")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#inherits"}),"inherits"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"className")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"string")))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"boolean")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"invalidate"},"invalidate"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"invalidate"),"(): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"isenabled"},"isEnabled"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"isEnabled"),"(): ",Object(r.b)("em",{parentName:"p"},"boolean")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"boolean")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"killtimer"},"killTimer"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"killTimer"),"(",Object(r.b)("inlineCode",{parentName:"p"},"timerId"),": number): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#killtimer"}),"killTimer"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"timerId")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"number")))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"objectname"},"objectName"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"objectName"),"(): ",Object(r.b)("em",{parentName:"p"},"string")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#objectname"}),"objectName"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"string")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"parent"},"parent"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"parent"),"(): ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"))),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#parent"}),"parent"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"))),Object(r.b)("hr",null),Object(r.b)("h3",{id:"property"},"property"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"property"),"(",Object(r.b)("inlineCode",{parentName:"p"},"name"),": string): ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qvariant"}),"QVariant"))),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#property"}),"property"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"name")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"string")))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qvariant"}),"QVariant"))),Object(r.b)("hr",null),Object(r.b)("h3",{id:"removeeventlistener"},"removeEventListener"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"removeEventListener"),"\u2039",Object(r.b)("strong",{parentName:"p"},"SignalType"),"\u203a(",Object(r.b)("inlineCode",{parentName:"p"},"signalType"),": SignalType, ",Object(r.b)("inlineCode",{parentName:"p"},"callback"),": Signals","[SignalType]",", ",Object(r.b)("inlineCode",{parentName:"p"},"options?"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/interfaces/eventlisteneroptions"}),"EventListenerOptions"),"): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget"}),"EventWidget"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget#removeeventlistener"}),"removeEventListener"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Type parameters:")),Object(r.b)("p",null,"\u25aa ",Object(r.b)("strong",{parentName:"p"},"SignalType"),": ",Object(r.b)("em",{parentName:"p"},"keyof Signals")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"signalType")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"SignalType")),Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"callback")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"Signals","[SignalType]")),Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"options?")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/interfaces/eventlisteneroptions"}),"EventListenerOptions"))))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"removeEventListener"),"(",Object(r.b)("inlineCode",{parentName:"p"},"eventType"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/enums/widgeteventtypes"}),"WidgetEventTypes"),", ",Object(r.b)("inlineCode",{parentName:"p"},"callback"),": function, ",Object(r.b)("inlineCode",{parentName:"p"},"options?"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/interfaces/eventlisteneroptions"}),"EventListenerOptions"),"): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget"}),"EventWidget"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget#removeeventlistener"}),"removeEventListener"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("p",null,"\u25aa ",Object(r.b)("strong",{parentName:"p"},"eventType"),": ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/enums/widgeteventtypes"}),"WidgetEventTypes"))),Object(r.b)("p",null,"\u25aa ",Object(r.b)("strong",{parentName:"p"},"callback"),": ",Object(r.b)("em",{parentName:"p"},"function")),Object(r.b)("p",null,"\u25b8 (",Object(r.b)("inlineCode",{parentName:"p"},"event?"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/globals#nativerawpointer"}),"NativeRawPointer"),'\u2039"QEvent"\u203a): ',Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"event?")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/globals#nativerawpointer"}),"NativeRawPointer"),'\u2039"QEvent"\u203a')))),Object(r.b)("p",null,"\u25aa",Object(r.b)("inlineCode",{parentName:"p"},"Optional")," ",Object(r.b)("strong",{parentName:"p"},"options"),": ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/interfaces/eventlisteneroptions"}),"EventListenerOptions"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"abstract-removewidget"},Object(r.b)("inlineCode",{parentName:"h3"},"Abstract")," removeWidget"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"removeWidget"),"(",Object(r.b)("inlineCode",{parentName:"p"},"childWidget"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/classes/qwidget"}),"QWidget"),"): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"childWidget")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/classes/qwidget"}),"QWidget"))))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"setcontentsmargins"},"setContentsMargins"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"setContentsMargins"),"(",Object(r.b)("inlineCode",{parentName:"p"},"left"),": number, ",Object(r.b)("inlineCode",{parentName:"p"},"top"),": number, ",Object(r.b)("inlineCode",{parentName:"p"},"right"),": number, ",Object(r.b)("inlineCode",{parentName:"p"},"bottom"),": number): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"left")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"number")),Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"top")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"number")),Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"right")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"number")),Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"bottom")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"number")))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"setenabled"},"setEnabled"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"setEnabled"),"(",Object(r.b)("inlineCode",{parentName:"p"},"enable"),": boolean): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"enable")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"boolean")))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"seteventprocessed"},"setEventProcessed"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"setEventProcessed"),"(",Object(r.b)("inlineCode",{parentName:"p"},"isProcessed"),": boolean): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget"}),"EventWidget"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/eventwidget#seteventprocessed"}),"setEventProcessed"))),Object(r.b)("p",null,"Mark the current event as having been processed"),Object(r.b)("p",null,"This method is used to indicate that the currently dispatched event\nhas been processed and no further processing by superclasses is\nrequired. It only makes sense to call this method from an event\nhandler."),Object(r.b)("p",null,"When set, this flag will cause NodeGui's ",Object(r.b)("inlineCode",{parentName:"p"},"QObject::event()")," method to\nreturn true and not call the superclass ",Object(r.b)("inlineCode",{parentName:"p"},"event()"),", effectively preventing\nany further processing on this event."),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Description"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"isProcessed")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"boolean"),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"true if the event has been processed.")))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"setobjectname"},"setObjectName"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"setObjectName"),"(",Object(r.b)("inlineCode",{parentName:"p"},"objectName"),": string): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#setobjectname"}),"setObjectName"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"objectName")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"string")))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"setparent"},"setParent"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"setParent"),"(",Object(r.b)("inlineCode",{parentName:"p"},"parent"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),"): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#setparent"}),"setParent"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"parent")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/classes/qobject"}),"QObject"))))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"setproperty"},"setProperty"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"setProperty"),"(",Object(r.b)("inlineCode",{parentName:"p"},"name"),": string, ",Object(r.b)("inlineCode",{parentName:"p"},"value"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/globals#qvarianttype"}),"QVariantType"),"): ",Object(r.b)("em",{parentName:"p"},"boolean")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#setproperty"}),"setProperty"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"name")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"string")),Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"value")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/globals#qvarianttype"}),"QVariantType"))))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"boolean")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"setsizeconstraint"},"setSizeConstraint"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"setSizeConstraint"),"(",Object(r.b)("inlineCode",{parentName:"p"},"constraint"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/enums/sizeconstraint"}),"SizeConstraint"),"): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"constraint")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/enums/sizeconstraint"}),"SizeConstraint"))))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"setspacing"},"setSpacing"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"setSpacing"),"(",Object(r.b)("inlineCode",{parentName:"p"},"spacing"),": number): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"spacing")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"number")))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"sizeconstraint"},"sizeConstraint"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"sizeConstraint"),"(): ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/enums/sizeconstraint"}),"SizeConstraint"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/enums/sizeconstraint"}),"SizeConstraint"))),Object(r.b)("hr",null),Object(r.b)("h3",{id:"spacing"},"spacing"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"spacing"),"(): ",Object(r.b)("em",{parentName:"p"},"number")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"number")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"starttimer"},"startTimer"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"startTimer"),"(",Object(r.b)("inlineCode",{parentName:"p"},"intervalMS"),": number, ",Object(r.b)("inlineCode",{parentName:"p"},"timerType"),": ",Object(r.b)("a",Object(b.a)({parentName:"p"},{href:"/docs/api/generated/enums/timertype"}),"TimerType"),"): ",Object(r.b)("em",{parentName:"p"},"number")),Object(r.b)("p",null,Object(r.b)("em",{parentName:"p"},"Inherited from ",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),".",Object(r.b)("a",Object(b.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject#starttimer"}),"startTimer"))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Parameters:")),Object(r.b)("table",null,Object(r.b)("thead",{parentName:"table"},Object(r.b)("tr",{parentName:"thead"},Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Name"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Type"),Object(r.b)("th",Object(b.a)({parentName:"tr"},{align:null}),"Default"))),Object(r.b)("tbody",{parentName:"table"},Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"intervalMS")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"number"),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"-")),Object(r.b)("tr",{parentName:"tbody"},Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("inlineCode",{parentName:"td"},"timerType")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),Object(r.b)("a",Object(b.a)({parentName:"td"},{href:"/docs/api/generated/enums/timertype"}),"TimerType")),Object(r.b)("td",Object(b.a)({parentName:"tr"},{align:null}),"TimerType.CoarseTimer")))),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"number")),Object(r.b)("hr",null),Object(r.b)("h3",{id:"update"},"update"),Object(r.b)("p",null,"\u25b8 ",Object(r.b)("strong",{parentName:"p"},"update"),"(): ",Object(r.b)("em",{parentName:"p"},"void")),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Returns:")," ",Object(r.b)("em",{parentName:"p"},"void")))}j.isMDXComponent=!0},467:function(e,t,a){"use strict";a.d(t,"a",(function(){return O})),a.d(t,"b",(function(){return d}));var b=a(0),n=a.n(b);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function c(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var b=Object.getOwnPropertySymbols(e);t&&(b=b.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,b)}return a}function l(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?c(Object(a),!0).forEach((function(t){r(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):c(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function p(e,t){if(null==e)return{};var a,b,n=function(e,t){if(null==e)return{};var a,b,n={},r=Object.keys(e);for(b=0;b<r.length;b++)a=r[b],t.indexOf(a)>=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(b=0;b<r.length;b++)a=r[b],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var i=n.a.createContext({}),j=function(e){var t=n.a.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},O=function(e){var t=j(e.components);return n.a.createElement(i.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.a.createElement(n.a.Fragment,{},t)}},m=n.a.forwardRef((function(e,t){var a=e.components,b=e.mdxType,r=e.originalType,c=e.parentName,i=p(e,["components","mdxType","originalType","parentName"]),O=j(a),m=b,d=O["".concat(c,".").concat(m)]||O[m]||s[m]||r;return a?n.a.createElement(d,l(l({ref:t},i),{},{components:a})):n.a.createElement(d,l({ref:t},i))}));function d(e,t){var a=arguments,b=t&&t.mdxType;if("string"==typeof e||b){var r=a.length,c=new Array(r);c[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:b,c[1]=l;for(var i=2;i<r;i++)c[i]=a[i];return n.a.createElement.apply(null,c)}return n.a.createElement.apply(null,a)}m.displayName="MDXCreateElement"}}]);