Enumerationmigueldeicaza.swiftgodot 0.45.0SwiftGodot
DropModeFlags
Tree.swift:67enum DropModeFlagsCases
case disabledDisables all drop sections, but still allows to detect the “on item” drop section by
getDropSectionAtPosition(_:).case onItemEnables the “on item” drop section. This drop section covers the entire item.
case inbetweenEnables “above item” and “below item” drop sections. The “above item” drop section covers the top half of the item, and the “below item” drop section covers the bottom half.
Other members in extension
View members
Hide members
This section is hidden by default because it contains too many (75) members.
Types
enum SelectModeclass Signal1Signal support.
class Signal2Signal support.
class Signal3Signal support.
class Signal4Signal support.
class Signal5Signal support.
class Signal6Signal support.
class Signal7Signal support.
class Signal8Signal support.
class Signal9Signal support.
Type members
Instance members
var allowReselect: BoolIf
true, the currently selected cell may be selected again.var allowRmbSelect: BoolIf
true, a right mouse button click can select items.var allowSearch: BoolIf
true, allows navigating theTreewith letter keys through incremental search.var cellSelected: SimpleSignalEmitted when a cell is selected.
var checkPropagatedToItem: Signal6Emitted when
propagateCheck(column:emitSignal:)is called. Connect to this signal to process the items that are affected whenpropagateCheck(column:emitSignal:)is invoked. The order that the items affected will be processed is as follows: the item that invoked the method, children of that item, and finally parents of that item.var columnTitleClicked: Signal9Emitted when a column’s title is clicked with either
leftorright.var columnTitlesVisible: BoolIf
true, column titles are visible.var columns: Int32The number of columns.
var customItemClicked: Signal4Emitted when an item with
TreeItem/TreeCellMode/cellModeCustomis clicked with a mouse button.var customPopupEdited: Signal8Emitted when a cell with the
TreeItem/TreeCellMode/cellModeCustomis clicked to be edited.var dropModeFlags: Int32The drop mode as an OR combination of flags. See
DropModeFlagsconstants. Once dropping is done, reverts to .dropModeDisabled. Setting this during_canDropData(atPosition:data:)is recommended.var emptyClicked: Signal3Emitted when a mouse button is clicked in the empty space of the tree.
var enableRecursiveFolding: BoolIf
true, recursive folding is enabled for thisTree. Holding down Shift while clicking the fold arrow collapses or uncollapses theTreeItemand all its descendants.var hideFolding: BoolIf
true, the folding arrow is hidden.var hideRoot: BoolIf
true, the tree’s root is hidden.var itemActivated: SimpleSignalEmitted when an item is double-clicked, or selected with a
ui_acceptinput event (e.g. using [kbd]Enter[/kbd] or [kbd]Space[/kbd] on the keyboard).var itemCollapsed: Signal5Emitted when an item is collapsed by a click on the folding arrow.
var itemEdited: SimpleSignalEmitted when an item is edited.
var itemIconDoubleClicked: SimpleSignalEmitted when an item’s icon is double-clicked. For a signal that emits when any part of the item is double-clicked, see [signal item_activated].
var itemMouseSelected: Signal2Emitted when an item is selected with a mouse button.
var itemSelected: SimpleSignalEmitted when an item is selected.
var multiSelected: Signal1Emitted instead of [signal item_selected] if
selectModeis set to .selectMulti.var nothingSelected: SimpleSignalEmitted when a left mouse button click does not select any item.
var scrollHorizontalEnabled: BoolIf
true, enables horizontal scrolling.var scrollVerticalEnabled: BoolIf
true, enables vertical scrolling.var selectMode: Tree.SelectModeAllows single or multiple selection. See the
SelectModeconstants.func clear() Clears the tree. This removes all items.
func createItem(parent: TreeItem?, index: Int32) -> TreeItem? Creates an item in the tree and adds it as a child of
parent, which can be either a validTreeItemornull.func deselectAll() Deselects all tree items (rows and columns). In .selectMulti mode also removes selection cursor.
func editSelected(forceEdit: Bool) -> Bool Edits the selected tree item as if it was clicked.
func ensureCursorIsVisible() Makes the currently focused cell visible.
func getButtonIdAtPosition(Vector2) -> Int32 Returns the button ID at
position, or -1 if no button is there.func getColumnAtPosition(Vector2) -> Int32 Returns the column index at
position, or -1 if no item is there.func getColumnExpandRatio(column: Int32) -> Int32 Returns the expand ratio assigned to the column.
func getColumnTitle(column: Int32) -> String Returns the column’s title.
func getColumnTitleAlignment(column: Int32) -> HorizontalAlignment Returns the column title alignment.
func getColumnTitleDirection(column: Int32) -> Control.TextDirection Returns column title base writing direction.
func getColumnTitleLanguage(column: Int32) -> String Returns column title language code.
func getColumnWidth(column: Int32) -> Int32 Returns the column’s width in pixels.
func getCustomPopupRect() -> Rect2 Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See
setCellMode(column:mode:).func getDropSectionAtPosition(Vector2) -> Int32 Returns the drop section at
position, or -100 if no item is there.func getEdited() -> TreeItem? Returns the currently edited item. Can be used with [signal item_edited] to get the item that was modified.
func getEditedColumn() -> Int32 Returns the column for the currently edited item.
func getItemAtPosition(Vector2) -> TreeItem? Returns the tree item at the specified position (relative to the tree origin position).
func getNextSelected(from: TreeItem?) -> TreeItem? Returns the next selected
TreeItemafter the given one, ornullif the end is reached.func getPressedButton() -> Int32 Returns the last pressed button’s index.
func getRoot() -> TreeItem? Returns the tree’s root item, or
nullif the tree is empty.func getScroll() -> Vector2 Returns the current scrolling position.
func getSelected() -> TreeItem? Returns the currently focused item, or
nullif no item is focused.func getSelectedColumn() -> Int32 Returns the currently focused column, or -1 if no column is focused.
func isColumnClippingContent(column: Int32) -> Bool Returns
trueif the column has enabled clipping (seesetColumnClipContent(column:enable:)).func isColumnExpanding(column: Int32) -> Bool Returns
trueif the column has enabled expanding (seesetColumnExpand(column:expand:)).func scrollToItem(TreeItem?, centerOnItem: Bool) Causes the
Treeto jump to the specifiedTreeItem.func setColumnClipContent(column: Int32, enable: Bool) Allows to enable clipping for column’s content, making the content size ignored.
func setColumnCustomMinimumWidth(column: Int32, minWidth: Int32) Overrides the calculated minimum width of a column. It can be set to
0to restore the default behavior. Columns that have the “Expand” flag will use their “min_width” in a similar fashion tosizeFlagsStretchRatio.func setColumnExpand(column: Int32, expand: Bool) If
true, the column will have the “Expand” flag ofControl. Columns that have the “Expand” flag will use their expand ratio in a similar fashion tosizeFlagsStretchRatio(seesetColumnExpandRatio(column:ratio:)).func setColumnExpandRatio(column: Int32, ratio: Int32) Sets the relative expand ratio for a column. See
setColumnExpand(column:expand:).func setColumnTitle(column: Int32, title: String) Sets the title of a column.
func setColumnTitleAlignment(column: Int32, titleAlignment: HorizontalAlignment) Sets the column title alignment. Note that
@GlobalScope.HORIZONTAL_ALIGNMENT_FILLis not supported for column titles.func setColumnTitleDirection(column: Int32, direction: Control.TextDirection) Sets column title base writing direction.
func setColumnTitleLanguage(column: Int32, language: String) Sets language code of column title used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
func setSelected(item: TreeItem?, column: Int32) Selects the specified
TreeItemand column.
Citizens in SwiftGodot
Conformances
protocol CaseIterableA type that provides a collection of all of its values.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol RawRepresentable<RawValue>A type that can be converted to and from an associated raw value.
Type members
Instance members
var debugDescription: StringA textual representation of this instance, suitable for debugging
Type features
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.