1 line
13 KiB
JavaScript
1 line
13 KiB
JavaScript
(window.webpackJsonp=window.webpackJsonp||[]).push([[87],{145:function(e,t,a){"use strict";a.r(t),a.d(t,"frontMatter",(function(){return b})),a.d(t,"metadata",(function(){return p})),a.d(t,"rightToc",(function(){return l})),a.d(t,"default",(function(){return s}));var r=a(2),n=a(6),c=(a(0),a(468)),b={id:"wrappercache",title:"WrapperCache",sidebar_label:"WrapperCache"},p={unversionedId:"api/generated/classes/wrappercache",id:"api/generated/classes/wrappercache",isDocsHomePage:!1,title:"WrapperCache",description:"JS side cache for wrapper objects.",source:"@site/docs/api/generated/classes/wrappercache.md",slug:"/api/generated/classes/wrappercache",permalink:"/docs/api/generated/classes/wrappercache",editUrl:"https://github.com/nodegui/nodegui/edit/master/website/docs/api/generated/classes/wrappercache.md",version:"current",sidebar_label:"WrapperCache",sidebar:"api",previous:{title:"StyleSheet",permalink:"/docs/api/generated/classes/stylesheet"},next:{title:"YogaWidget",permalink:"/docs/api/generated/classes/yogawidget"}},l=[{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:"logCreateQObject",id:"logcreateqobject",children:[]},{value:"logDestoryQObject",id:"logdestoryqobject",children:[]}]},{value:"Methods",id:"methods-1",children:[{value:"_flush",id:"_flush",children:[]},{value:"get",id:"get",children:[]},{value:"getWrapper",id:"getwrapper",children:[]},{value:"registerWrapper",id:"registerwrapper",children:[]},{value:"store",id:"store",children:[]}]}],o={rightToc:l};function s(e){var t=e.components,a=Object(n.a)(e,["components"]);return Object(c.b)("wrapper",Object(r.a)({},o,a,{components:t,mdxType:"MDXLayout"}),Object(c.b)("p",null,"JS side cache for wrapper objects."),Object(c.b)("p",null,'This is mainly used for caching wrappers of Qt objects which are not\ndirectly created by our Nodejs application. The purpose of the cache\nis to keep "alive" wrapper objects and their underlying C++ wrappers\nwhich may be connected to Qt signals from the real Qt object.\nThis makes it easier for application to grab one of these objects,\nset up event handlers, and then let the object go and ',Object(c.b)("em",{parentName:"p"},"not")," have the\nwrapper automatically and unexpectedly garbage collected."),Object(c.b)("h2",{id:"hierarchy"},"Hierarchy"),Object(c.b)("ul",null,Object(c.b)("li",{parentName:"ul"},Object(c.b)("strong",{parentName:"li"},"WrapperCache"))),Object(c.b)("h2",{id:"index"},"Index"),Object(c.b)("h3",{id:"constructors"},"Constructors"),Object(c.b)("ul",null,Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/api/generated/classes/wrappercache#constructor"}),"constructor"))),Object(c.b)("h3",{id:"properties"},"Properties"),Object(c.b)("ul",null,Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/api/generated/classes/wrappercache#logcreateqobject"}),"logCreateQObject")),Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/api/generated/classes/wrappercache#logdestoryqobject"}),"logDestoryQObject"))),Object(c.b)("h3",{id:"methods"},"Methods"),Object(c.b)("ul",null,Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/api/generated/classes/wrappercache#_flush"}),"_flush")),Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/api/generated/classes/wrappercache#get"}),"get")),Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/api/generated/classes/wrappercache#getwrapper"}),"getWrapper")),Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/api/generated/classes/wrappercache#registerwrapper"}),"registerWrapper")),Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/api/generated/classes/wrappercache#store"}),"store"))),Object(c.b)("h2",{id:"constructors-1"},"Constructors"),Object(c.b)("h3",{id:"constructor"},"constructor"),Object(c.b)("p",null,"+"," ",Object(c.b)("strong",{parentName:"p"},"new WrapperCache"),"(): ",Object(c.b)("em",{parentName:"p"},Object(c.b)("a",Object(r.a)({parentName:"em"},{href:"/docs/api/generated/classes/wrappercache"}),"WrapperCache"))),Object(c.b)("p",null,Object(c.b)("strong",{parentName:"p"},"Returns:")," ",Object(c.b)("em",{parentName:"p"},Object(c.b)("a",Object(r.a)({parentName:"em"},{href:"/docs/api/generated/classes/wrappercache"}),"WrapperCache"))),Object(c.b)("h2",{id:"properties-1"},"Properties"),Object(c.b)("h3",{id:"logcreateqobject"},"logCreateQObject"),Object(c.b)("p",null,"\u2022 ",Object(c.b)("strong",{parentName:"p"},"logCreateQObject"),": ",Object(c.b)("em",{parentName:"p"},"boolean")," = false"),Object(c.b)("hr",null),Object(c.b)("h3",{id:"logdestoryqobject"},"logDestoryQObject"),Object(c.b)("p",null,"\u2022 ",Object(c.b)("strong",{parentName:"p"},"logDestoryQObject"),": ",Object(c.b)("em",{parentName:"p"},"boolean")," = false"),Object(c.b)("h2",{id:"methods-1"},"Methods"),Object(c.b)("h3",{id:"_flush"},"_flush"),Object(c.b)("p",null,"\u25b8 ",Object(c.b)("strong",{parentName:"p"},"_flush"),"(): ",Object(c.b)("em",{parentName:"p"},"void")),Object(c.b)("p",null,Object(c.b)("strong",{parentName:"p"},"Returns:")," ",Object(c.b)("em",{parentName:"p"},"void")),Object(c.b)("hr",null),Object(c.b)("h3",{id:"get"},"get"),Object(c.b)("p",null,"\u25b8 ",Object(c.b)("strong",{parentName:"p"},"get"),"\u2039",Object(c.b)("strong",{parentName:"p"},"T"),"\u203a(",Object(c.b)("inlineCode",{parentName:"p"},"wrapperConstructor"),": object, ",Object(c.b)("inlineCode",{parentName:"p"},"native"),": ",Object(c.b)("a",Object(r.a)({parentName:"p"},{href:"/docs/api/generated/globals#nativeelement"}),"NativeElement"),"): ",Object(c.b)("em",{parentName:"p"},"T")),Object(c.b)("p",null,Object(c.b)("strong",{parentName:"p"},"Type parameters:")),Object(c.b)("p",null,"\u25aa ",Object(c.b)("strong",{parentName:"p"},"T"),": ",Object(c.b)("em",{parentName:"p"},Object(c.b)("a",Object(r.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject"))),Object(c.b)("p",null,Object(c.b)("strong",{parentName:"p"},"Parameters:")),Object(c.b)("p",null,"\u25aa ",Object(c.b)("strong",{parentName:"p"},"wrapperConstructor"),": ",Object(c.b)("em",{parentName:"p"},"object")),Object(c.b)("table",null,Object(c.b)("thead",{parentName:"table"},Object(c.b)("tr",{parentName:"thead"},Object(c.b)("th",Object(r.a)({parentName:"tr"},{align:null}),"Name"),Object(c.b)("th",Object(r.a)({parentName:"tr"},{align:null}),"Type"))),Object(c.b)("tbody",{parentName:"table"},Object(c.b)("tr",{parentName:"tbody"},Object(c.b)("td",Object(r.a)({parentName:"tr"},{align:null}),Object(c.b)("inlineCode",{parentName:"td"},"constructor")),Object(c.b)("td",Object(r.a)({parentName:"tr"},{align:null}))))),Object(c.b)("p",null,"\u25aa ",Object(c.b)("strong",{parentName:"p"},"native"),": ",Object(c.b)("em",{parentName:"p"},Object(c.b)("a",Object(r.a)({parentName:"em"},{href:"/docs/api/generated/globals#nativeelement"}),"NativeElement"))),Object(c.b)("p",null,Object(c.b)("strong",{parentName:"p"},"Returns:")," ",Object(c.b)("em",{parentName:"p"},"T")),Object(c.b)("hr",null),Object(c.b)("h3",{id:"getwrapper"},"getWrapper"),Object(c.b)("p",null,"\u25b8 ",Object(c.b)("strong",{parentName:"p"},"getWrapper"),"(",Object(c.b)("inlineCode",{parentName:"p"},"native"),": any): ",Object(c.b)("em",{parentName:"p"},Object(c.b)("a",Object(r.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject")," | null")),Object(c.b)("p",null,Object(c.b)("strong",{parentName:"p"},"Parameters:")),Object(c.b)("table",null,Object(c.b)("thead",{parentName:"table"},Object(c.b)("tr",{parentName:"thead"},Object(c.b)("th",Object(r.a)({parentName:"tr"},{align:null}),"Name"),Object(c.b)("th",Object(r.a)({parentName:"tr"},{align:null}),"Type"))),Object(c.b)("tbody",{parentName:"table"},Object(c.b)("tr",{parentName:"tbody"},Object(c.b)("td",Object(r.a)({parentName:"tr"},{align:null}),Object(c.b)("inlineCode",{parentName:"td"},"native")),Object(c.b)("td",Object(r.a)({parentName:"tr"},{align:null}),"any")))),Object(c.b)("p",null,Object(c.b)("strong",{parentName:"p"},"Returns:")," ",Object(c.b)("em",{parentName:"p"},Object(c.b)("a",Object(r.a)({parentName:"em"},{href:"/docs/api/generated/classes/qobject"}),"QObject")," | null")),Object(c.b)("hr",null),Object(c.b)("h3",{id:"registerwrapper"},"registerWrapper"),Object(c.b)("p",null,"\u25b8 ",Object(c.b)("strong",{parentName:"p"},"registerWrapper"),"(",Object(c.b)("inlineCode",{parentName:"p"},"qobjectClassName"),": string, ",Object(c.b)("inlineCode",{parentName:"p"},"wrapperConstructor"),": object): ",Object(c.b)("em",{parentName:"p"},"void")),Object(c.b)("p",null,Object(c.b)("strong",{parentName:"p"},"Parameters:")),Object(c.b)("p",null,"\u25aa ",Object(c.b)("strong",{parentName:"p"},"qobjectClassName"),": ",Object(c.b)("em",{parentName:"p"},"string")),Object(c.b)("p",null,"\u25aa ",Object(c.b)("strong",{parentName:"p"},"wrapperConstructor"),": ",Object(c.b)("em",{parentName:"p"},"object")),Object(c.b)("table",null,Object(c.b)("thead",{parentName:"table"},Object(c.b)("tr",{parentName:"thead"},Object(c.b)("th",Object(r.a)({parentName:"tr"},{align:null}),"Name"),Object(c.b)("th",Object(r.a)({parentName:"tr"},{align:null}),"Type"))),Object(c.b)("tbody",{parentName:"table"},Object(c.b)("tr",{parentName:"tbody"},Object(c.b)("td",Object(r.a)({parentName:"tr"},{align:null}),Object(c.b)("inlineCode",{parentName:"td"},"constructor")),Object(c.b)("td",Object(r.a)({parentName:"tr"},{align:null}))))),Object(c.b)("p",null,Object(c.b)("strong",{parentName:"p"},"Returns:")," ",Object(c.b)("em",{parentName:"p"},"void")),Object(c.b)("hr",null),Object(c.b)("h3",{id:"store"},"store"),Object(c.b)("p",null,"\u25b8 ",Object(c.b)("strong",{parentName:"p"},"store"),"(",Object(c.b)("inlineCode",{parentName:"p"},"wrapper"),": ",Object(c.b)("a",Object(r.a)({parentName:"p"},{href:"/docs/api/generated/classes/qobject"}),"QObject"),"): ",Object(c.b)("em",{parentName:"p"},"void")),Object(c.b)("p",null,Object(c.b)("strong",{parentName:"p"},"Parameters:")),Object(c.b)("table",null,Object(c.b)("thead",{parentName:"table"},Object(c.b)("tr",{parentName:"thead"},Object(c.b)("th",Object(r.a)({parentName:"tr"},{align:null}),"Name"),Object(c.b)("th",Object(r.a)({parentName:"tr"},{align:null}),"Type"))),Object(c.b)("tbody",{parentName:"table"},Object(c.b)("tr",{parentName:"tbody"},Object(c.b)("td",Object(r.a)({parentName:"tr"},{align:null}),Object(c.b)("inlineCode",{parentName:"td"},"wrapper")),Object(c.b)("td",Object(r.a)({parentName:"tr"},{align:null}),Object(c.b)("a",Object(r.a)({parentName:"td"},{href:"/docs/api/generated/classes/qobject"}),"QObject"))))),Object(c.b)("p",null,Object(c.b)("strong",{parentName:"p"},"Returns:")," ",Object(c.b)("em",{parentName:"p"},"void")))}s.isMDXComponent=!0},468:function(e,t,a){"use strict";a.d(t,"a",(function(){return i})),a.d(t,"b",(function(){return d}));var r=a(0),n=a.n(r);function c(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function b(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?b(Object(a),!0).forEach((function(t){c(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):b(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function l(e,t){if(null==e)return{};var a,r,n=function(e,t){if(null==e)return{};var a,r,n={},c=Object.keys(e);for(r=0;r<c.length;r++)a=c[r],t.indexOf(a)>=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(r=0;r<c.length;r++)a=c[r],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=n.a.createContext({}),s=function(e){var t=n.a.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},i=function(e){var t=s(e.components);return n.a.createElement(o.Provider,{value:t},e.children)},j={inlineCode:"code",wrapper:function(e){var t=e.children;return n.a.createElement(n.a.Fragment,{},t)}},O=n.a.forwardRef((function(e,t){var a=e.components,r=e.mdxType,c=e.originalType,b=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),i=s(a),O=r,d=i["".concat(b,".").concat(O)]||i[O]||j[O]||c;return a?n.a.createElement(d,p(p({ref:t},o),{},{components:a})):n.a.createElement(d,p({ref:t},o))}));function d(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var c=a.length,b=new Array(c);b[0]=O;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p.mdxType="string"==typeof e?e:r,b[1]=p;for(var o=2;o<c;o++)b[o]=a[o];return n.a.createElement.apply(null,b)}return n.a.createElement.apply(null,a)}O.displayName="MDXCreateElement"}}]); |