git0 0.2.10 → 0.2.11

package/svelte-nodegui/website/docs/api/interfaces/textprops.md

@@ -0,0 +1,277 @@
+---
+id: "textprops"
+title: "TextProps"
+sidebar_label: "TextProps"
+---
+
+## Hierarchy
+
+  ↳ [ViewProps](viewprops.md)‹QLabelSignals›
+
+  ↳ **TextProps**
+
+  ↳ [ImageProps](imageprops.md)
+
+  ↳ [AnimatedImageProps](animatedimageprops.md)
+
+## Index
+
+### Properties
+
+* [attributes](textprops.md#optional-attributes)
+* [children](textprops.md#optional-children)
+* [cursor](textprops.md#optional-cursor)
+* [enabled](textprops.md#optional-enabled)
+* [geometry](textprops.md#optional-geometry)
+* [id](textprops.md#optional-id)
+* [maxSize](textprops.md#optional-maxsize)
+* [minSize](textprops.md#optional-minsize)
+* [mouseTracking](textprops.md#optional-mousetracking)
+* [on](textprops.md#optional-on)
+* [openExternalLinks](textprops.md#optional-openexternallinks)
+* [pos](textprops.md#optional-pos)
+* [ref](textprops.md#optional-ref)
+* [scaledContents](textprops.md#optional-scaledcontents)
+* [size](textprops.md#optional-size)
+* [style](textprops.md#optional-style)
+* [styleSheet](textprops.md#optional-stylesheet)
+* [textInteractionFlags](textprops.md#optional-textinteractionflags)
+* [visible](textprops.md#optional-visible)
+* [windowFlags](textprops.md#optional-windowflags)
+* [windowIcon](textprops.md#optional-windowicon)
+* [windowOpacity](textprops.md#optional-windowopacity)
+* [windowState](textprops.md#optional-windowstate)
+* [windowTitle](textprops.md#optional-windowtitle)
+* [wordWrap](textprops.md#optional-wordwrap)
+
+## Properties
+
+### `Optional` attributes
+
+• **attributes**? : *[WidgetAttributesMap](../globals.md#widgetattributesmap)*
+
+*Inherited from [ViewProps](viewprops.md).[attributes](viewprops.md#optional-attributes)*
+
+Prop to set the Widget Attributes. example:
+`<View attributes={{[WidgetAttributes.WA_Disabled]: true}} />`
+
+___
+
+### `Optional` children
+
+• **children**? : *string | number | Array‹string | number›*
+
+___
+
+### `Optional` cursor
+
+• **cursor**? : *CursorShape | QCursor*
+
+*Inherited from [ViewProps](viewprops.md).[cursor](viewprops.md#optional-cursor)*
+
+Sets the window mouse cursor. [QWidget: setCursor](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetcursorcursor)
+
+___
+
+### `Optional` enabled
+
+• **enabled**? : *undefined | false | true*
+
+*Inherited from [ViewProps](viewprops.md).[enabled](viewprops.md#optional-enabled)*
+
+Sets the property that tells whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. [QWidget: setEnabled](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetenabledenabled)
+
+___
+
+### `Optional` geometry
+
+• **geometry**? : *[Geometry](../globals.md#geometry)*
+
+*Inherited from [ViewProps](viewprops.md).[geometry](viewprops.md#optional-geometry)*
+
+Sets the screen position as well as size of the widget. [QWidget: setGeometry](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetgeometryx-y-width-height)
+
+___
+
+### `Optional` id
+
+• **id**? : *undefined | string*
+
+*Inherited from [ViewProps](viewprops.md).[id](viewprops.md#optional-id)*
+
+Sets the object name (id) of the widget in Qt. Object name can be analogous to id of an element in the web world. Using the objectName of the widget one can reference it in the Qt's stylesheet much like what we do with id in the web world. [QWidget: setObjectName](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetobjectnameobjectname)
+
+___
+
+### `Optional` maxSize
+
+• **maxSize**? : *[Size](../globals.md#size)*
+
+*Inherited from [ViewProps](viewprops.md).[maxSize](viewprops.md#optional-maxsize)*
+
+Sets the maximum size of the widget. [QWidget: setMaximumSize](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetmaximumsizewidth-height)
+
+___
+
+### `Optional` minSize
+
+• **minSize**? : *[Size](../globals.md#size)*
+
+*Inherited from [ViewProps](viewprops.md).[minSize](viewprops.md#optional-minsize)*
+
+Sets the minimum size of the widget. [QWidget: setMinimumSize](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetminimumsizewidth-height)
+
+___
+
+### `Optional` mouseTracking
+
+• **mouseTracking**? : *undefined | false | true*
+
+*Inherited from [ViewProps](viewprops.md).[mouseTracking](viewprops.md#optional-mousetracking)*
+
+Sets the property that tells whether mouseTracking is enabled for the widget. [QWidget: setMouseTracking](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetmousetrackingismousetracked)
+
+___
+
+### `Optional` on
+
+• **on**? : *Partial‹[WidgetEventListeners](../globals.md#widgeteventlisteners) | QLabelSignals›*
+
+*Inherited from [ViewProps](viewprops.md).[on](viewprops.md#optional-on)*
+
+Prop to set the event listener map. See [Handlong Events](/docs/guides/handle-events)
+
+___
+
+### `Optional` openExternalLinks
+
+• **openExternalLinks**? : *undefined | false | true*
+
+___
+
+### `Optional` pos
+
+• **pos**? : *[Position](../globals.md#position)*
+
+*Inherited from [ViewProps](viewprops.md).[pos](viewprops.md#optional-pos)*
+
+Sets the screen position of the widget. [QWidget: move](https://docs.nodegui.org/docs/api/NodeWidget#widgetmovex-y)
+
+___
+
+### `Optional` ref
+
+• **ref**? : *any*
+
+*Inherited from [ViewProps](viewprops.md).[ref](viewprops.md#optional-ref)*
+
+Prop to set the ref. The ref will return the underlying nodegui widget.
+
+___
+
+### `Optional` scaledContents
+
+• **scaledContents**? : *undefined | false | true*
+
+___
+
+### `Optional` size
+
+• **size**? : *[ViewSize](../globals.md#viewsize)*
+
+*Inherited from [ViewProps](viewprops.md).[size](viewprops.md#optional-size)*
+
+Sets both the minimum and maximum sizes of the widget. [QWidget: setFixedSize](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetfixedsizewidth-height)
+
+___
+
+### `Optional` style
+
+• **style**? : *undefined | string*
+
+*Inherited from [ViewProps](viewprops.md).[style](viewprops.md#optional-style)*
+
+Sets the inline stylesheet property. [QWidget: setInlineStyle](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetinlinestylestyle)
+
+___
+
+### `Optional` styleSheet
+
+• **styleSheet**? : *undefined | string*
+
+*Inherited from [ViewProps](viewprops.md).[styleSheet](viewprops.md#optional-stylesheet)*
+
+Sets the property that holds the widget's style sheet. [QWidget: setStyleSheet](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetstylesheetstylesheet)
+
+___
+
+### `Optional` textInteractionFlags
+
+• **textInteractionFlags**? : *TextInteractionFlag*
+
+___
+
+### `Optional` visible
+
+• **visible**? : *undefined | false | true*
+
+*Inherited from [ViewProps](viewprops.md).[visible](viewprops.md#optional-visible)*
+
+Shows or hides the widget and its children. [QWidget: show](https://docs.nodegui.org/docs/api/NodeWidget#widgetshow)
+
+___
+
+### `Optional` windowFlags
+
+• **windowFlags**? : *[WindowFlagsMap](../globals.md#windowflagsmap)*
+
+*Inherited from [ViewProps](viewprops.md).[windowFlags](viewprops.md#optional-windowflags)*
+
+Prop to set the Widget flags. example:
+`<View windowFlags={{[WindowType.SplashScreen]: true}} />`
+
+___
+
+### `Optional` windowIcon
+
+• **windowIcon**? : *QIcon*
+
+*Inherited from [ViewProps](viewprops.md).[windowIcon](viewprops.md#optional-windowicon)*
+
+Sets the window icon. [QWidget: setWindowIcon](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowiconicon)
+
+___
+
+### `Optional` windowOpacity
+
+• **windowOpacity**? : *undefined | number*
+
+*Inherited from [ViewProps](viewprops.md).[windowOpacity](viewprops.md#optional-windowopacity)*
+
+This property holds the level of opacity for the window. [QWidget: setWindowOpacity](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowopacityopacity)
+
+___
+
+### `Optional` windowState
+
+• **windowState**? : *WindowState*
+
+*Inherited from [ViewProps](viewprops.md).[windowState](viewprops.md#optional-windowstate)*
+
+Sets the window state. [QWidget: setWindowState](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowstatestate)
+
+___
+
+### `Optional` windowTitle
+
+• **windowTitle**? : *undefined | string*
+
+*Inherited from [ViewProps](viewprops.md).[windowTitle](viewprops.md#optional-windowtitle)*
+
+Sets the window title property. [QWidget: setWindowTitle](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowtitletitle)
+
+___
+
+### `Optional` wordWrap
+
+• **wordWrap**? : *undefined | false | true*

package/svelte-nodegui/website/docs/api/interfaces/viewprops.md

@@ -0,0 +1,261 @@
+---
+id: "viewprops"
+title: "ViewProps"
+sidebar_label: "ViewProps"
+---
+
+The View component can be used to encapsulate other components and provide structure.
+It functions similar to a div in the web world. It is based on
+[NodeGui's QWidget](https://docs.nodegui.org/docs/api/QWidget).
+## Example
+
+```html
+<script lang="ts">
+  import { onMount } from "svelte";
+  const buttonStyle = "color: white;";
+
+  onMount(() => {
+    (window as any).win = win; // Prevent garbage collection.
+    win.nativeView.show();
+    return () => {
+      delete (window as any).win;
+    };
+  });
+</script>
+
+<window bind:this={win}>
+  <view>
+    <button style="{buttonStyle}">Hello</button>
+    <button style="{buttonStyle}">World</button>
+  </view>
+</window>
+```
+
+## Type parameters
+
+▪ **Signals**: *object*
+
+## Hierarchy
+
+* RNProps
+
+  ↳ **ViewProps**
+
+  ↳ [BoxViewProps](boxviewprops.md)
+
+  ↳ [GridViewProps](gridviewprops.md)
+
+  ↳ [SliderProps](sliderprops.md)
+
+  ↳ [WindowProps](windowprops.md)
+
+  ↳ [TextProps](textprops.md)
+
+  ↳ [AbstractButtonProps](abstractbuttonprops.md)
+
+  ↳ [LineEditProps](lineeditprops.md)
+
+  ↳ [MenuProps](menuprops.md)
+
+  ↳ [MenuBarProps](menubarprops.md)
+
+  ↳ [PlainTextEditProps](plaintexteditprops.md)
+
+  ↳ [ProgressBarProps](progressbarprops.md)
+
+  ↳ [DialProps](dialprops.md)
+
+  ↳ [SpinBoxProps](spinboxprops.md)
+
+  ↳ [ScrollAreaProps](scrollareaprops.md)
+
+  ↳ [ComboBoxProps](comboboxprops.md)
+
+  ↳ [TabProps](tabprops.md)
+
+## Index
+
+### Properties
+
+* [attributes](viewprops.md#optional-attributes)
+* [cursor](viewprops.md#optional-cursor)
+* [enabled](viewprops.md#optional-enabled)
+* [geometry](viewprops.md#optional-geometry)
+* [id](viewprops.md#optional-id)
+* [maxSize](viewprops.md#optional-maxsize)
+* [minSize](viewprops.md#optional-minsize)
+* [mouseTracking](viewprops.md#optional-mousetracking)
+* [on](viewprops.md#optional-on)
+* [pos](viewprops.md#optional-pos)
+* [ref](viewprops.md#optional-ref)
+* [size](viewprops.md#optional-size)
+* [style](viewprops.md#optional-style)
+* [styleSheet](viewprops.md#optional-stylesheet)
+* [visible](viewprops.md#optional-visible)
+* [windowFlags](viewprops.md#optional-windowflags)
+* [windowIcon](viewprops.md#optional-windowicon)
+* [windowOpacity](viewprops.md#optional-windowopacity)
+* [windowState](viewprops.md#optional-windowstate)
+* [windowTitle](viewprops.md#optional-windowtitle)
+
+## Properties
+
+### `Optional` attributes
+
+• **attributes**? : *[WidgetAttributesMap](../globals.md#widgetattributesmap)*
+
+Prop to set the Widget Attributes. example:
+`<View attributes={{[WidgetAttributes.WA_Disabled]: true}} />`
+
+___
+
+### `Optional` cursor
+
+• **cursor**? : *CursorShape | QCursor*
+
+Sets the window mouse cursor. [QWidget: setCursor](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetcursorcursor)
+
+___
+
+### `Optional` enabled
+
+• **enabled**? : *undefined | false | true*
+
+Sets the property that tells whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. [QWidget: setEnabled](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetenabledenabled)
+
+___
+
+### `Optional` geometry
+
+• **geometry**? : *[Geometry](../globals.md#geometry)*
+
+Sets the screen position as well as size of the widget. [QWidget: setGeometry](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetgeometryx-y-width-height)
+
+___
+
+### `Optional` id
+
+• **id**? : *undefined | string*
+
+Sets the object name (id) of the widget in Qt. Object name can be analogous to id of an element in the web world. Using the objectName of the widget one can reference it in the Qt's stylesheet much like what we do with id in the web world. [QWidget: setObjectName](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetobjectnameobjectname)
+
+___
+
+### `Optional` maxSize
+
+• **maxSize**? : *[Size](../globals.md#size)*
+
+Sets the maximum size of the widget. [QWidget: setMaximumSize](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetmaximumsizewidth-height)
+
+___
+
+### `Optional` minSize
+
+• **minSize**? : *[Size](../globals.md#size)*
+
+Sets the minimum size of the widget. [QWidget: setMinimumSize](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetminimumsizewidth-height)
+
+___
+
+### `Optional` mouseTracking
+
+• **mouseTracking**? : *undefined | false | true*
+
+Sets the property that tells whether mouseTracking is enabled for the widget. [QWidget: setMouseTracking](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetmousetrackingismousetracked)
+
+___
+
+### `Optional` on
+
+• **on**? : *Partial‹[WidgetEventListeners](../globals.md#widgeteventlisteners) | Signals›*
+
+Prop to set the event listener map. See [Handlong Events](/docs/guides/handle-events)
+
+___
+
+### `Optional` pos
+
+• **pos**? : *[Position](../globals.md#position)*
+
+Sets the screen position of the widget. [QWidget: move](https://docs.nodegui.org/docs/api/NodeWidget#widgetmovex-y)
+
+___
+
+### `Optional` ref
+
+• **ref**? : *any*
+
+Prop to set the ref. The ref will return the underlying nodegui widget.
+
+___
+
+### `Optional` size
+
+• **size**? : *[ViewSize](../globals.md#viewsize)*
+
+Sets both the minimum and maximum sizes of the widget. [QWidget: setFixedSize](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetfixedsizewidth-height)
+
+___
+
+### `Optional` style
+
+• **style**? : *undefined | string*
+
+Sets the inline stylesheet property. [QWidget: setInlineStyle](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetinlinestylestyle)
+
+___
+
+### `Optional` styleSheet
+
+• **styleSheet**? : *undefined | string*
+
+Sets the property that holds the widget's style sheet. [QWidget: setStyleSheet](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetstylesheetstylesheet)
+
+___
+
+### `Optional` visible
+
+• **visible**? : *undefined | false | true*
+
+Shows or hides the widget and its children. [QWidget: show](https://docs.nodegui.org/docs/api/NodeWidget#widgetshow)
+
+___
+
+### `Optional` windowFlags
+
+• **windowFlags**? : *[WindowFlagsMap](../globals.md#windowflagsmap)*
+
+Prop to set the Widget flags. example:
+`<View windowFlags={{[WindowType.SplashScreen]: true}} />`
+
+___
+
+### `Optional` windowIcon
+
+• **windowIcon**? : *QIcon*
+
+Sets the window icon. [QWidget: setWindowIcon](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowiconicon)
+
+___
+
+### `Optional` windowOpacity
+
+• **windowOpacity**? : *undefined | number*
+
+This property holds the level of opacity for the window. [QWidget: setWindowOpacity](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowopacityopacity)
+
+___
+
+### `Optional` windowState
+
+• **windowState**? : *WindowState*
+
+Sets the window state. [QWidget: setWindowState](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowstatestate)
+
+___
+
+### `Optional` windowTitle
+
+• **windowTitle**? : *undefined | string*
+
+Sets the window title property. [QWidget: setWindowTitle](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowtitletitle)