QML Item Element
The Item is the most basic of all visual items in QML. More...
在QML中,Item是所有可视化项的基础。
Inherited by BorderImage, Column, Flickable, Flipable, Flow, FocusPanel, FocusScope, GestureArea, Grid, Image, Loader, MouseArea, Particles, PathView,Rectangle, Repeater, Row, Text, TextEdit, TextInput, and WebView.
Item instantiates the C++ class QDeclarativeItem
Item实例化C++类QDeclarativeItem
Properties
- activeFocus : bool
- anchors.baseline : AnchorLine
- anchors.baselineOffset : real
- anchors.bottom : AnchorLine
- anchors.bottomMargin : real
- anchors.centerIn : Item
- anchors.fill : Item
- anchors.horizontalCenter : AnchorLine
- anchors.horizontalCenterOffset : real
- anchors.left : AnchorLine
- anchors.leftMargin : real
- anchors.margins : real
- anchors.right : AnchorLine
- anchors.rightMargin : real
- anchors.top : AnchorLine
- anchors.topMargin : real
- anchors.verticalCenter : AnchorLine
- anchors.verticalCenterOffset : real
- children : list<Item>
- childrenRect.height : real
- childrenRect.width : real
- childrenRect.x : real
- childrenRect.y : real
- clip : bool
- data : list<Object>
- focus : bool
- height : real
- opacity : real
- parent : Item
- resources : list<Object>
- rotation : real
- scale : real
- state : string
- states : list<State>
- transform : list<Transform>
- transformOrigin : enumeration
- transitions : list<Transition>
- visible : bool
- width : real
- x : real
- y : real
- z : real
Methods
Detailed Description
All visual items in Qt Declarative inherit from Item. Although Item has no visual appearance, it defines all the properties that are common across visual items - such as the x and y position, the width and height, anchoring and key handling.
在Qt Declarative中所有可视元素都继承自Item, Item本身并不可视,只是用它定义了所有可视元素公有的属性。例如像x,y坐标,width宽度,height高度,锚anchoring以及按键处理等。
Item is also useful for grouping items together.
Item还有个用处就是将很多的item组织起来。
- Item {
- Image {
- source: "tile.png"
- }
- Image {
- x: 80
- width: 100
- height: 100
- source: "tile.png"
- }
- Image {
- x: 190
- width: 100
- height: 100
- fillMode: Image.Tile
- source: "tile.png"
- }
- }
Item { Image { source: "tile.png" } Image { x: 80 width: 100 height: 100 source: "tile.png" } Image { x: 190 width: 100 height: 100 fillMode: Image.Tile source: "tile.png" } }
Key Handling
Key handling is available to all Item-based visual elements via the Keys attached property. The Keys attached property provides basic handlers such as onPressed and onReleased, as well as handlers for specific keys, such as onCancelPressed. The example below assigns focus to the item and handles the Left key via the general onPressed handler and the Select key via the onSelectPressed handler:
所有继承自Item的可视化元素都可以通过Keys这个附加属性来处理按键。Keys附加属性提供一些基础的按键处理,例如onPressed和onReleased,当然也有一些特定按键的处理,例如onCancelPressed。下面这个例子描述了如何给一个item设置焦点,如何通过onPressed和onSelectPressed来处理左键。
- Item {
- focus: true
- Keys.onPressed: {
- if (event.key == Qt.Key_Left) {
- console.log("move left");
- event.accepted = true;
- }
- }
- Keys.onSelectPressed: console.log("Selected");
- }
Item { focus: true Keys.onPressed: { if (event.key == Qt.Key_Left) { console.log("move left"); event.accepted = true; } } Keys.onSelectPressed: console.log("Selected"); }
See the Keys attached property for detailed documentation.
Property Documentation
read-onlyactiveFocus : bool
This property indicates whether the item has active focus.
这个属性表明当前的item是否处于焦点状态。
An item with active focus will receive keyboard input, or is a FocusScope ancestor of the item that will receive keyboard input.
一个item只有在处于焦点的状态或者是一个FocusScope中的一个元素下才能接收键盘输入。
Usually, activeFocus is gained by setting focus on an item and its enclosing FocusScopes. In the following example input will have activeFocus.
通常,当对某个item设置焦点以及对包含它的FocusScopes设置焦点时,activeFocus被置为真。在下面的例子中,input将会有一个为真的activeFocus。
- Rectangle {
- FocusScope {
- focus: true
- TextInput {
- id: input
- focus: true
- }
- }
- }
Rectangle { FocusScope { focus: true TextInput { id: input focus: true } } }
See also focus and Keyboard Focus .
anchors.margins : real
anchors.topMargin : real
anchors.bottomMargin : real
anchors.leftMargin : real
anchors.rightMargin : real
anchors.horizontalCenterOffset : real
anchors.verticalCenterOffset : real
anchors.baselineOffset : real
Anchors provide a way to position an item by specifying its relationship with other items.
Margins apply to top, bottom, left, right, and fill anchors. The anchors.margins property can be used to set all of the various margins at once, to the same value. Note that margins are anchor-specific and are not applied if an item does not use anchors.
Offsets apply for horizontal center, vertical center, and baseline anchors.
Text anchored to Image, horizontally centered and vertically below, with a margin.
- Image { id: pic; ... }
- Text {
- id: label
- anchors.horizontalCenter: pic.horizontalCenter
- anchors.top: pic.bottom
- anchors.topMargin: 5
- ...
- }
Image { id: pic; ... } Text { id: label anchors.horizontalCenter: pic.horizontalCenter anchors.top: pic.bottom anchors.topMargin: 5 ... }
Left of Text anchored to right of Image, with a margin. The y property of both defaults to 0.
- Image { id: pic; ... }
- Text {
- id: label
- anchors.left: pic.right
- anchors.leftMargin: 5
- ...
- }
Image { id: pic; ... } Text { id: label anchors.left: pic.right anchors.leftMargin: 5 ... }
anchors.fill provides a convenient way for one item to have the same geometry as another item, and is equivalent to connecting all four directional anchors.
To clear an anchor value, set it to undefined.
Note: You can only anchor an item to siblings or a parent.
For more information see Anchor Layouts.
The children property contains the list of visual children of this item. The resources property contains non-visual resources that you want to reference by name.
Generally you can rely on Item's default property to handle all this for you, but it can come in handy in some cases.
children属性包含该item的所有可见子item的一个列表。resources包含了不可见的资源,但我们可以通过资源名来引用这些资源。通常这两个属性无需关心太多,只是在某些情况下会用到。
- Item {
- children: [
- Text {},
- Rectangle {}
- ]
- resources: [
- Component {
- id: myComponent
- Text {}
- }
- ]
- }
Item { children: [ Text {}, Rectangle {} ] resources: [ Component { id: myComponent Text {} } ] }
通过childrenRect的属性集,我们可以访问该item的子item的坐标位置大小信息。
read-onlychildrenRect.x : real
read-onlychildrenRect.y : real
read-onlychildrenRect.width : real
read-onlychildrenRect.height : real
The childrenRect properties allow an item access to the geometry of its children. This property is useful if you have an item that needs to be sized to fit its children.
clip : bool
This property holds whether clipping is enabled. The default clip value is false.
clip属性表明是否允许剪切。默认为false。
If clipping is enabled, an item will clip its own painting, as well as the painting of its children, to its bounding rectangle.
Non-rectangular clipping regions are not supported for performance reasons.
read-onlydefaultdata : list<Object>
The data property allows you to freely mix visual children and resources in an item. If you assign a visual item to the data list it becomes a child and if you assign any other object type, it is added as a resource.
data属性允许我们自由组合子item和资源。当向data列表中加入一个可视的item时,它会成为这个item的子item,如果是其他类型,则会作为资源加进来。
So you can write:
- Item {
- Text {}
- Rectangle {}
- Timer {}
- }
Item { Text {} Rectangle {} Timer {} }
- instead of:
instead of:
- Item {
- children: [
- Text {},
- Rectangle {}
- ]
- resources: [
- Timer {}
- ]
- }
Item { children: [ Text {}, Rectangle {} ] resources: [ Timer {} ] }
data is a behind-the-scenes property: you should never need to explicitly specify it.
focus : bool
This property indicates whether the item has focus within the enclosing focus scope. If true, this item will gain active focus when the enclosing focus scope gains active focus. In the following example, input will be given active focus when scope gains active focus.
focus属性用来表明在囊括它的最小FocusScope中,这个item是否有焦点。如果为真,则当囊括它的最小FocusScope获得焦点时,这个item也会获得焦点。在下面的例子中,当scope获得焦点,input会获得焦点。
- Rectangle {
- FocusScope {
- id: scope
- TextInput {
- id: input
- focus: true
- }
- }
- }
Rectangle { FocusScope { id: scope TextInput { id: input focus: true } } }
For the purposes of this property, the scene as a whole is assumed to act like a focus scope. On a practical level, that means the following QML will give active focus to input on startup.
程序启动时input将会获得焦点。
- Rectangle {
- TextInput {
- id: input
- focus: true
- }
- }
Rectangle { TextInput { id: input focus: true } }
See also activeFocus and Keyboard Focus.
opacity : real
The opacity of the item. Opacity is specified as a number between 0 (fully transparent) and 1 (fully opaque). The default is 1.
顾名思义,这个属性是用来设置该item的不透明性的,它可以再0-1之间取值,0表示完全透明,1表示完全不透明,默认值为1,即不透明。
Opacity is an inherited attribute. That is, the opacity is also applied individually to child items. In almost all cases this is what you want, but in some cases (like the following example) it may produce undesired results.
这个属性是一个有继承性的属性,也就是说这个属性会遗传给它的所有子item。
- Item {
- Rectangle {
- color: "red"
- width: 100; height: 100
- Rectangle {
- color: "blue"
- x: 50; y: 50; width: 100; height: 100
- }
- }
- }
Item { Rectangle { color: "red" width: 100; height: 100 Rectangle { color: "blue" x: 50; y: 50; width: 100; height: 100 } } }
- Item {
- Rectangle {
- opacity: 0.5
- color: "red"
- width: 100; height: 100
- Rectangle {
- color: "blue"
- x: 50; y: 50; width: 100; height: 100
- }
- }
- }
Item { Rectangle { opacity: 0.5 color: "red" width: 100; height: 100 Rectangle { color: "blue" x: 50; y: 50; width: 100; height: 100 } } }
parent属性是指该item的父item.
rotation : real
This property holds the rotation of the item in degrees clockwise.
rotation属性表明顺时针旋转的角度
This specifies how many degrees to rotate the item around its transformOrigin. The default rotation is 0 degrees (i.e. not rotated at all).
rotation属性表明该item绕着它的transformOrigin的角度。默认旋转0度。
- Rectangle {
- color: "blue"
- width: 100; height: 100
- Rectangle {
- color: "red"
- x: 25; y: 25; width: 50; height: 50
- rotation: 30
- }
- }
Rectangle { color: "blue" width: 100; height: 100 Rectangle { color: "red" x: 25; y: 25; width: 50; height: 50 rotation: 30 } }
scale : real
This property holds the scale of the item.
A scale of less than 1 means the item will be displayed smaller than normal, and a scale of greater than 1 means the item will be displayed larger than normal. A negative scale means the item will be mirrored.
By default, items are displayed at a scale of 1 (i.e. at their normal size).
scale属性用来表明该item缩放的比例。小于1表示缩小,大于1表示放大。负数表示镜像。默认值为1,表示不缩放。
Scaling is from the item's transformOrigin.
- Rectangle {
- color: "blue"
- width: 100; height: 100
- Rectangle {
- color: "green"
- width: 25; height: 25
- }
- Rectangle {
- color: "red"
- x: 25; y: 25; width: 50; height: 50
- scale: 1.4
- }
- }
Rectangle { color: "blue" width: 100; height: 100 Rectangle { color: "green" width: 25; height: 25 } Rectangle { color: "red" x: 25; y: 25; width: 50; height: 50 scale: 1.4 } }
state : string
This property holds the name of the current state of the item.
state属性是该item当前状态的名字。
This property is often used in scripts to change between states. For example:
这个属性经常会在脚本中切换状态时用到。如下例所示:
- function toggle() {
- if (button.state == 'On')
- button.state = 'Off';
- else
- button.state = 'On';
- }
function toggle() { if (button.state == 'On') button.state = 'Off'; else button.state = 'On'; }
If the item is in its base state (i.e. no explicit state has been set), state will be a blank string. Likewise, you can return an item to its base state by setting its current state to ''.如果一个item处于它的基状态,即没有显示地给它赋予某个状态时,这个状态是一个空字符,你可以将state赋值为空字符,这样它便会回到基状态。
See also States.
This property holds a list of states defined by the item.
states属性是该item的所有状态的列表。
- Item {
- states: [
- State { ... },
- State { ... }
- ...
- ]
- }
Item { states: [ State { ... }, State { ... } ... ] }
See also States .
This property holds the list of transformations to apply.
For more information see Transform.
transform属性持有的是一组变换。详情请参考Transform元素。
transformOrigin : enumeration
This property holds the origin point around which scale and rotation transform.
transformOrigin属性持有的是缩放和旋转的最起始点。
Nine transform origins are available, as shown in the image below.
共有9个变化起始点。如下图所示:
This example rotates an image around its bottom-right corner.
Image { source: "myimage.png" transformOrigin: Item.BottomRight rotation: 45 }
The default transform origin is Item.Center.
默认的transformOrigin是Item.Center.
To set an arbitrary transform origin point use the Scale or Rotation transform elements.
设定一个任意变换原点使用Scale或Rotation变换的元素。
read-onlytransitions : list<Transition>
This property holds a list of transitions defined by the item.
transitions属性持有了一组transition变换。详情请参考Transitions元素。
- Item {
- transitions: [
- Transition { ... },
- Transition { ... }
- ...
- ]
- }
Item { transitions: [ Transition { ... }, Transition { ... } ... ] }
See also QML Transitions.
visible : bool
Whether the item is visible. By default this is true.
表示是否可见。默认可见。
Note: visible is not linked to actual visibility; if an item moves off screen, or the opacity changes to 0, this will not affect the visible property.
Defines the item's position and size relative to its parent.
这组属性定义了该item的位置,其中x,y是相对于其父item的坐标。
Item { x: 100; y: 100; width: 100; height: 100 }
z : real
Sets the stacking order of sibling items. By default the stacking order is 0.
z属性可以认为是该item的z轴坐标。默认值为0。
Items with a higher stacking value are drawn on top of siblings with a lower stacking order. Items with the same stacking value are drawn bottom up in the order they appear. Items with a negative stacking value are drawn under their parent's content.
z越大越画在前面,如果为负值则画在父Item的后面。相同z值的item按照定义的次序来画。
The following example shows the various effects of stacking order.
Same z - later children above earlier children:
- Item {
- Rectangle {
- color: "red"
- width: 100; height: 100
- }
- Rectangle {
- color: "blue"
- x: 50; y: 50; width: 100; height: 100
- }
- }
Item { Rectangle { color: "red" width: 100; height: 100 } Rectangle { color: "blue" x: 50; y: 50; width: 100; height: 100 } }
Higher z on top:
- Item {
- Rectangle {
- z: 1
- color: "red"
- width: 100; height: 100
- }
- Rectangle {
- color: "blue"
- x: 50; y: 50; width: 100; height: 100
- }
- }
Item { Rectangle { z: 1 color: "red" width: 100; height: 100 } Rectangle { color: "blue" x: 50; y: 50; width: 100; height: 100 } }
Same z - children above parents:
- Item {
- Rectangle {
- color: "red"
- width: 100; height: 100
- Rectangle {
- color: "blue"
- x: 50; y: 50; width: 100; height: 100
- }
- }
- }
Item { Rectangle { color: "red" width: 100; height: 100 Rectangle { color: "blue" x: 50; y: 50; width: 100; height: 100 } } }
Lower z below:
- Item {
- Rectangle {
- color: "red"
- width: 100; height: 100
- Rectangle {
- z: -1
- color: "blue"
- x: 50; y: 50; width: 100; height: 100
- }
- }
- }
Item { Rectangle { color: "red" width: 100; height: 100 Rectangle { z: -1 color: "blue" x: 50; y: 50; width: 100; height: 100 } } }
Method Documentation
Returns the visible child item at point (x, y), which is in this item's coordinate system, or null if there is no such item.
返回在坐标(x,y)的子item,这里的坐标是相对于该item的。如果返回null表明没有这样一个子item。
Force active focus on the item. This method sets focus on the item and makes sure that all the focus scopes higher in the object hierarchy are also given focus.
强制为该item设置焦点,此方法会导致该item所处的所有FocusScope获得焦点。
Maps the point (x, y), which is in item's coordinate system, to this item's coordinate system, and returns an object with x and y properties matching the mapped cooordinate.
将item的(x,y)映射到该Item中返回与(x,y)对应的对象。
If item is a null value, this maps the point from the coordinate system of the root QML view.如果item为空,则(x,y)是相对于最顶层QML视图的坐标系统。
Maps the point (x, y), which is in this item's coordinate system, to item's coordinate system, and returns an object with x and y properties matching the mapped cooordinate.
将该Item的(x,y)映射到item中返回与(x,y)对应的对象。
If item is a null value, this maps x and y to the coordinate system of the root QML view.如果item为空,则(x,y)是相对于最顶层QML视图的坐标系统。