OverlayDrawer QML Type
| Import Statement: | import org.kde.kirigami |
| Inherited By: |
Properties
- animating : bool
- collapsed : bool
- collapsedSize : int
- collapsible : bool
(since 2.5) - drawerOpen : bool
- handle : Item
- handleClosedIcon : KTP.IconPropertiesGroup
(since 2.5) - handleClosedToolTip : string
(since 2.15) - handleOpenIcon : KTP.IconPropertiesGroup
(since 2.5) - handleOpenToolTip : string
(since 2.15) - handleVisible : bool
- icon.color : color
(since 2.5) - icon.fromControlsIcon : function
(since 2.5) - icon.height : real
(since 2.5) - icon.name : string
(since 2.5) - icon.source : var
(since 2.5) - icon.width : real
(since 2.5) - peeking : bool
Detailed Description
Overlay Drawers are used to expose additional UI elements needed for small secondary tasks for which the main UI elements are not needed. For example in Okular Mobile, an Overlay Drawer is used to display thumbnails of all pages within a document along with a search field. This is used for the distinct task of navigating to another page.
Property Documentation
animating : bool |
This property tells whether the drawer is currently opening or closing itself.
collapsed : bool |
This property tells whether the drawer is collapsed to a very thin sidebar, usually icon only.
When true, the drawer will be collapsed to a very thin sidebar, usually icon only.
Only collapsible drawers can be collapsed.
default: false
See also collapsible.
collapsedSize : int |
This property holds the size of the collapsed drawer.
For vertical drawers this will be the width of the drawer and for horizontal drawers this will be the height of the drawer.
default: Units.iconSizes.medium, just enough to accommodate medium sized icons
collapsible : bool |
This property holds whether the drawer can be collapsed to a very thin, usually icon only sidebar.
Only modal drawers are collapsible. Collapsible is not supported in the mobile mode.
This property was introduced in 2.5.
drawerOpen : bool |
This property tells whether the drawer is open and visible.
default: false
handle : Item |
Readonly property that points to the item that will act as a physical handle for the Drawer.
handleClosedIcon : KTP.IconPropertiesGroup |
This grouped property holds the description of an optional icon.
If no custom icon is set, an X icon is shown, which will morph into the Menu or overflow icons.
For OverlayDrawer the default is view-right-new or view-left-new depending on the drawer location.
| Name | Description |
|---|---|
| name | This property holds icon name. The icon will be loaded from the platform theme. If the icon is found in the theme, it will always be used; even if icon.source is also set. If the icon is not found, icon.source will be used instead. |
| source | This property holds the icon source. The icon will be loaded as a regular image. |
| width | This property holds the width of the icon. |
| height | This property holds the height of the icon. |
| color | This property holds the icon tint color. The icon is tinted with the specified color, unless the color is set to "transparent". |
| fromControlsIcon | Bind this icon to all matching properties of a Controls icon group. This function automatically binds all properties to matching properties of a controls icon group, since we cannot just reuse the Controls icon group. To use it, you can assign the result to an IconPropertiesGroup, like so: icon: icon.fromControlsIcon(control.icon). |
This property was introduced in 2.5.
handleClosedToolTip : string |
This property holds the tooltip displayed when the drawer is closed.
This property was introduced in 2.15.
handleOpenIcon : KTP.IconPropertiesGroup |
This property holds the options for handle's open icon.
If no custom icon is set, a menu icon is shown for the application globalDrawer and an overflow menu icon is shown for the contextDrawer. That's the default for the GlobalDrawer and ContextDrawer components respectively.
For OverlayDrawer the default is view-right-close or view-left-close depending on the drawer location
| Name | Description |
|---|---|
| name | This property holds icon name. The icon will be loaded from the platform theme. If the icon is found in the theme, it will always be used; even if icon.source is also set. If the icon is not found, icon.source will be used instead. |
| source | This property holds the icon source. The icon will be loaded as a regular image. |
| width | This property holds the width of the icon. |
| height | This property holds the height of the icon. |
| color | This property holds the icon tint color. The icon is tinted with the specified color, unless the color is set to "transparent". |
| fromControlsIcon | Bind this icon to all matching properties of a Controls icon group. This function automatically binds all properties to matching properties of a controls icon group, since we cannot just reuse the Controls icon group. To use it, you can assign the result to an IconPropertiesGroup, like so: icon: icon.fromControlsIcon(control.icon). |
This property was introduced in 2.5.
handleOpenToolTip : string |
This property holds the tooltip displayed when the drawer is open.
This property was introduced in 2.15.
handleVisible : bool |
This property holds whether the handle is visible, to make opening the drawer easier.
Currently supported only on left and right drawers.
icon.color : color |
This grouped property holds the description of an optional icon.
If no custom icon is set, an X icon is shown, which will morph into the Menu or overflow icons.
For OverlayDrawer the default is view-right-new or view-left-new depending on the drawer location.
| Name | Description |
|---|---|
| name | This property holds icon name. The icon will be loaded from the platform theme. If the icon is found in the theme, it will always be used; even if icon.source is also set. If the icon is not found, icon.source will be used instead. |
| source | This property holds the icon source. The icon will be loaded as a regular image. |
| width | This property holds the width of the icon. |
| height | This property holds the height of the icon. |
| color | This property holds the icon tint color. The icon is tinted with the specified color, unless the color is set to "transparent". |
| fromControlsIcon | Bind this icon to all matching properties of a Controls icon group. This function automatically binds all properties to matching properties of a controls icon group, since we cannot just reuse the Controls icon group. To use it, you can assign the result to an IconPropertiesGroup, like so: icon: icon.fromControlsIcon(control.icon). |
This property was introduced in 2.5.
icon.fromControlsIcon : function |
This grouped property holds the description of an optional icon.
If no custom icon is set, an X icon is shown, which will morph into the Menu or overflow icons.
For OverlayDrawer the default is view-right-new or view-left-new depending on the drawer location.
| Name | Description |
|---|---|
| name | This property holds icon name. The icon will be loaded from the platform theme. If the icon is found in the theme, it will always be used; even if icon.source is also set. If the icon is not found, icon.source will be used instead. |
| source | This property holds the icon source. The icon will be loaded as a regular image. |
| width | This property holds the width of the icon. |
| height | This property holds the height of the icon. |
| color | This property holds the icon tint color. The icon is tinted with the specified color, unless the color is set to "transparent". |
| fromControlsIcon | Bind this icon to all matching properties of a Controls icon group. This function automatically binds all properties to matching properties of a controls icon group, since we cannot just reuse the Controls icon group. To use it, you can assign the result to an IconPropertiesGroup, like so: icon: icon.fromControlsIcon(control.icon). |
This property was introduced in 2.5.
icon.height : real |
This grouped property holds the description of an optional icon.
If no custom icon is set, an X icon is shown, which will morph into the Menu or overflow icons.
For OverlayDrawer the default is view-right-new or view-left-new depending on the drawer location.
| Name | Description |
|---|---|
| name | This property holds icon name. The icon will be loaded from the platform theme. If the icon is found in the theme, it will always be used; even if icon.source is also set. If the icon is not found, icon.source will be used instead. |
| source | This property holds the icon source. The icon will be loaded as a regular image. |
| width | This property holds the width of the icon. |
| height | This property holds the height of the icon. |
| color | This property holds the icon tint color. The icon is tinted with the specified color, unless the color is set to "transparent". |
| fromControlsIcon | Bind this icon to all matching properties of a Controls icon group. This function automatically binds all properties to matching properties of a controls icon group, since we cannot just reuse the Controls icon group. To use it, you can assign the result to an IconPropertiesGroup, like so: icon: icon.fromControlsIcon(control.icon). |
This property was introduced in 2.5.
icon.name : string |
This grouped property holds the description of an optional icon.
If no custom icon is set, an X icon is shown, which will morph into the Menu or overflow icons.
For OverlayDrawer the default is view-right-new or view-left-new depending on the drawer location.
| Name | Description |
|---|---|
| name | This property holds icon name. The icon will be loaded from the platform theme. If the icon is found in the theme, it will always be used; even if icon.source is also set. If the icon is not found, icon.source will be used instead. |
| source | This property holds the icon source. The icon will be loaded as a regular image. |
| width | This property holds the width of the icon. |
| height | This property holds the height of the icon. |
| color | This property holds the icon tint color. The icon is tinted with the specified color, unless the color is set to "transparent". |
| fromControlsIcon | Bind this icon to all matching properties of a Controls icon group. This function automatically binds all properties to matching properties of a controls icon group, since we cannot just reuse the Controls icon group. To use it, you can assign the result to an IconPropertiesGroup, like so: icon: icon.fromControlsIcon(control.icon). |
This property was introduced in 2.5.
icon.source : var |
This grouped property holds the description of an optional icon.
If no custom icon is set, an X icon is shown, which will morph into the Menu or overflow icons.
For OverlayDrawer the default is view-right-new or view-left-new depending on the drawer location.
| Name | Description |
|---|---|
| name | This property holds icon name. The icon will be loaded from the platform theme. If the icon is found in the theme, it will always be used; even if icon.source is also set. If the icon is not found, icon.source will be used instead. |
| source | This property holds the icon source. The icon will be loaded as a regular image. |
| width | This property holds the width of the icon. |
| height | This property holds the height of the icon. |
| color | This property holds the icon tint color. The icon is tinted with the specified color, unless the color is set to "transparent". |
| fromControlsIcon | Bind this icon to all matching properties of a Controls icon group. This function automatically binds all properties to matching properties of a controls icon group, since we cannot just reuse the Controls icon group. To use it, you can assign the result to an IconPropertiesGroup, like so: icon: icon.fromControlsIcon(control.icon). |
This property was introduced in 2.5.
icon.width : real |
This grouped property holds the description of an optional icon.
If no custom icon is set, an X icon is shown, which will morph into the Menu or overflow icons.
For OverlayDrawer the default is view-right-new or view-left-new depending on the drawer location.
| Name | Description |
|---|---|
| name | This property holds icon name. The icon will be loaded from the platform theme. If the icon is found in the theme, it will always be used; even if icon.source is also set. If the icon is not found, icon.source will be used instead. |
| source | This property holds the icon source. The icon will be loaded as a regular image. |
| width | This property holds the width of the icon. |
| height | This property holds the height of the icon. |
| color | This property holds the icon tint color. The icon is tinted with the specified color, unless the color is set to "transparent". |
| fromControlsIcon | Bind this icon to all matching properties of a Controls icon group. This function automatically binds all properties to matching properties of a controls icon group, since we cannot just reuse the Controls icon group. To use it, you can assign the result to an IconPropertiesGroup, like so: icon: icon.fromControlsIcon(control.icon). |
This property was introduced in 2.5.
peeking : bool |
This property tells whether the drawer is in a state between open and closed.
The drawer is visible but not completely open. This is usually the case when the user is dragging the drawer from a screen edge, so the user is "peeking" at what's in the drawer.
default: false