diff --git a/doc/base/classes.xml b/doc/base/classes.xml index f6ea8b08ee5..ab4610d4f70 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -42920,18 +42920,33 @@ + Control to show a tree of items. + This shows a tree of items that can be selected, expanded and collapsed. The tree can have multiple columns with custom controls like text editing, buttons and popups. It can be useful for structural displaying and interactions. + Trees are built via code, using [TreeItem] objects to create the structure. They have a single root but multiple root can be simulated if a dummy hidden root is added. + [codeblock] + func _ready(): + var tree = Tree.new() + var root = tree.create_item() + tree.set_hide_root(true) + var child1 = tree.create_item(root) + var child2 = tree.create_item(root) + var subchild1 = tree.create_item(child1) + subchild1.set_text(0, "Subchild1") + [/codeblock] + Get whether the column titles are being shown. + Clear the tree. This erases all of the items. @@ -42940,16 +42955,19 @@ + Create an item in the tree and add it as the last child of [code]parent[/code]. If parent is not given, it will be added as the last child of the root, or it'll the be the root itself if the tree is empty. + Make the current selected item visible. This will scroll the tree to make sure the selected item is in sight. + Get whether a right click can select items. @@ -42958,6 +42976,7 @@ + Get the column index under the given point. @@ -42966,6 +42985,7 @@ + Get the title of the given column. @@ -42974,36 +42994,42 @@ + Get the width of the given column in pixels. + Get the amount of columns. + Get the rectangle for custom popups. Helper to create custom cell controls that display a popup. See [method TreeItem.set_cell_mode]. + Get the flags of the current drop mode. + Get the current edited item. This is only available for custom cell mode. + Get the column of the cell for the current edited icon. This is only available for custom cell mode. @@ -43014,6 +43040,7 @@ + Get the rectangle area of the the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. @@ -43022,6 +43049,7 @@ + Get the tree item at the specified position (relative to the tree origin position). @@ -43030,42 +43058,49 @@ + Get the next selected item after the given one. + Get the index of the last pressed button. + Get the root item of the tree. + Get the current scrolling position. + Get the currently selected item. + Get the column number of the current selection. + Get whether the editing of a cell should only happen when it is already selected. @@ -43078,12 +43113,14 @@ + Get whether the folding arrow is hidden. + Set whether or not a right mouse button click can select items. @@ -43092,6 +43129,7 @@ + Set whether a column will have the "Expand" flag of [Control]. @@ -43100,6 +43138,7 @@ + Set the minimum width of a column. @@ -43108,18 +43147,21 @@ + Set the title of a column. + Set whether the column titles visibility. + Set the amount of columns. @@ -43132,30 +43174,35 @@ + Set the drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. + Set whether the folding arrow should be hidden. + Set whether the root of the tree should be hidden. + Set the selection mode. Use one of the [code]SELECT_*[/code] constants. + Set whether the editing of a cell should only happen when it is already selected. @@ -43168,32 +43215,38 @@ + Emitted when a button on the tree was pressed (see [method TreeItem.add_button]). + Emitted when a cell is selected. + Emitted when a cell with the [code]CELL_MODE_CUSTOM[/code] is clicked to be edited. + Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty. + Emitted when an item is activated (double-clicked). + Emitted when an item is collapsed by a click on the folding arrow. @@ -43202,16 +43255,19 @@ + Emitted when an item is editted. + Emitted when an item is selected with right mouse button. + Emitted when an item is selected with right mouse button. @@ -45238,136 +45294,160 @@ do_property]. + Control to play video files. + This control has the ability to play video streams. The only format accepted is the OGV Theora, so any other format must be converted before using in a project. + Get the selected audio track (for multitrack videos). + Get the amount of miliseconds to store in buffer while playing. + Get the video stream. + Get the name of the video stream. + Get the current position of the stream, in seconds. + Get the current frame of the video as a [Texture]. + Get the volume of the audio track as a linear value. + Get the volume of the audio track in decibels. + Get whether or not the video is set as autoplay. + Get whether or not the expand property is set. + Get whether or not the video is paused. + Get whether or not the video is playing. + Start the video playback. + Set the audio track (for multitrack videos). + Set whether this node should start playing automatically. + Set the amount of miliseconds to buffer during playback. + Set the expand property. If enabled, the video will grow or shrink to fit the player size, otherwise it will play at the stream resolution. + Set whether the video should pause the playback. + Set the video stream for this player. + Set the audio volume as a linear value. + Set the audio volume in decibels. + Stop the video playback. @@ -49767,14 +49847,17 @@ do_property]. + Low-level class for creating parsers for XML files. + This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low level so it can be applied to any possible schema. + Get the amount of attributes in the current element. @@ -49783,6 +49866,7 @@ do_property]. + Get the name of the attribute specified by the index in [code]idx[/code] argument. @@ -49791,12 +49875,14 @@ do_property]. + Get the value of the attribute specified by the index in [code]idx[/code] argument. + Get the current line in the parsed file (currently not implemented). @@ -49805,6 +49891,7 @@ do_property]. + Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. @@ -49813,30 +49900,35 @@ do_property]. + Get the value of a certain attribute of the current element by name. This will return an empty [String] if the attribute is not found. + Get the contents of a text node. This will raise an error in any other type of node. + Get the name of the current element node. This will raise an error if the current node type is not [code]NODE_ELEMENT[/code] nor [code]NODE_ELEMENT_END[/code] + Get the byte offset of the current node since the beginning of the file or buffer. + Get the type of the current node. Compare with [code]NODE_*[/code] constants. @@ -49845,12 +49937,14 @@ do_property]. + Check whether or not the current element has a certain attribute. + Check whether the current element is empty (this only works for completely empty tags, e.g. <element \>). @@ -49859,6 +49953,7 @@ do_property]. + Open a XML file for parsing. This returns an error code. @@ -49867,12 +49962,14 @@ do_property]. + Open a XML raw buffer for parsing. This returns an error code. + Read the next node of the file. This returns an error code. @@ -49881,27 +49978,36 @@ do_property]. + Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. + Skips the current section. If the node contains other elements, they will be ignored and the cursor will go to the closing of the current element. + There's no node (no file or buffer opened) + Element (tag) + End of element + Text node + Comment node + CDATA content + Unknown node