From b96e8d588620bc7160bd4ccaab515de8f9c48edc Mon Sep 17 00:00:00 2001 From: Alexander Hartmann Date: Wed, 26 Mar 2025 17:07:12 +0100 Subject: [PATCH] Tree: apply comment style guidelines and remove unused variables. Co-Authored-By: Tomasz Chabora <2223172+KoBeWi@users.noreply.github.com> Co-Authored-By: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> --- scene/gui/tree.cpp | 137 ++++++++++++++++++--------------------------- scene/gui/tree.h | 51 ++++++----------- 2 files changed, 74 insertions(+), 114 deletions(-) diff --git a/scene/gui/tree.cpp b/scene/gui/tree.cpp index 9ecdc25c76d..d69293feabb 100644 --- a/scene/gui/tree.cpp +++ b/scene/gui/tree.cpp @@ -156,7 +156,6 @@ void TreeItem::_change_tree(Tree *p_tree) { } } -/* cell mode */ void TreeItem::set_cell_mode(int p_column, TreeCellMode p_mode) { ERR_FAIL_INDEX(p_column, cells.size()); @@ -185,7 +184,6 @@ TreeItem::TreeCellMode TreeItem::get_cell_mode(int p_column) const { return cells[p_column].mode; } -/* auto translate mode */ void TreeItem::set_auto_translate_mode(int p_column, Node::AutoTranslateMode p_mode) { ERR_FAIL_INDEX(p_column, cells.size()); @@ -205,7 +203,6 @@ Node::AutoTranslateMode TreeItem::get_auto_translate_mode(int p_column) const { return cells[p_column].auto_translate_mode; } -/* multiline editable */ void TreeItem::set_edit_multiline(int p_column, bool p_multiline) { ERR_FAIL_INDEX(p_column, cells.size()); cells.write[p_column].edit_multiline = p_multiline; @@ -217,7 +214,6 @@ bool TreeItem::is_edit_multiline(int p_column) const { return cells[p_column].edit_multiline; } -/* check mode */ void TreeItem::set_checked(int p_column, bool p_checked) { ERR_FAIL_INDEX(p_column, cells.size()); @@ -235,7 +231,7 @@ void TreeItem::set_checked(int p_column, bool p_checked) { void TreeItem::set_indeterminate(int p_column, bool p_indeterminate) { ERR_FAIL_INDEX(p_column, cells.size()); - // Prevent uncheck if indeterminate set to false twice + // Prevent uncheck if indeterminate set to false twice. if (p_indeterminate == cells[p_column].indeterminate) { return; } @@ -592,7 +588,6 @@ int TreeItem::get_icon_max_width(int p_column) const { return cells[p_column].icon_max_w; } -/* range works for mode number or mode combo */ void TreeItem::set_range(int p_column, double p_value) { ERR_FAIL_INDEX(p_column, cells.size()); if (cells[p_column].step > 0) { @@ -692,7 +687,7 @@ void TreeItem::set_collapsed(bool p_collapsed) { while (ci && ci != this) { ci = ci->parent; } - if (ci) { // collapsing cursor/selected, move it! + if (ci) { // Collapsing cursor/selected, move it! if (tree->select_mode == Tree::SELECT_MULTI) { tree->selected_item = this; @@ -824,8 +819,6 @@ int TreeItem::get_custom_minimum_height() const { return custom_min_height; } -/* Item manipulation */ - TreeItem *TreeItem::create_child(int p_index) { TreeItem *ti = memnew(TreeItem(tree)); if (tree) { @@ -935,7 +928,7 @@ TreeItem *TreeItem::get_prev() { if (!parent || parent->first_child == this) { return nullptr; } - // This is an edge case + // This is an edge case. TreeItem *l_prev = parent->first_child; while (l_prev && l_prev->next != this) { l_prev = l_prev->next; @@ -1864,12 +1857,7 @@ TreeItem::~TreeItem() { clear_children(); } -/**********************************************/ -/**********************************************/ -/**********************************************/ -/**********************************************/ -/**********************************************/ -/**********************************************/ +/*************************** END of TreeItem ***************************/ void Tree::_update_theme_item_cache() { Control::_update_theme_item_cache(); @@ -1924,7 +1912,7 @@ int Tree::get_item_height(TreeItem *p_item) const { int height = compute_item_height(p_item); height += theme_cache.v_separation; - if (!p_item->collapsed) { /* if not collapsed, check the children */ + if (!p_item->collapsed) { // If not collapsed, check the children. TreeItem *c = p_item->first_child; @@ -2117,7 +2105,7 @@ void Tree::update_item_cache(TreeItem *p_item) const { int Tree::draw_item(const Point2i &p_pos, const Point2 &p_draw_ofs, const Size2 &p_draw_size, TreeItem *p_item, int &r_self_height) { if (p_pos.y - theme_cache.offset.y > (p_draw_size.height)) { - return -1; //draw no more! + return -1; // Draw no more! } if (!p_item->is_visible_in_tree()) { @@ -2131,8 +2119,7 @@ int Tree::draw_item(const Point2i &p_pos, const Point2 &p_draw_ofs, const Size2 int label_h = 0; bool rtl = cache.rtl; - /* Draw label, if height fits */ - + // Draw label, if height fits. bool skip = (p_item == root && hide_root); if (!skip) { @@ -2193,7 +2180,7 @@ int Tree::draw_item(const Point2i &p_pos, const Point2 &p_draw_ofs, const Size2 } } - int item_width_with_buttons = item_width; // used later for drawing buttons + int item_width_with_buttons = item_width; // Used later for drawing buttons. int buttons_width = 0; for (int j = p_item->cells[i].buttons.size() - 1; j >= 0; j--) { Ref button_texture = p_item->cells[i].buttons[j].texture; @@ -2350,7 +2337,7 @@ int Tree::draw_item(const Point2i &p_pos, const Point2 &p_draw_ofs, const Size2 RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(r.position.x, r.position.y + r.size.y, r.size.x, 1), theme_cache.drop_position_color); } } else if (drop_mode_over == p_item->get_parent()) { - if (drop_mode_section == 1 && !p_item->get_prev() /* && !drop_mode_over->is_collapsed() */) { // The drop_mode_over shouldn't ever be collapsed in here, otherwise we would be drawing a child of a collapsed item. + if (drop_mode_section == 1 && !p_item->get_prev()) { // Line above. RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(r.position.x, r.position.y, r.size.x, 1), theme_cache.drop_position_color); } @@ -2587,7 +2574,7 @@ int Tree::draw_item(const Point2i &p_pos, const Point2 &p_draw_ofs, const Size2 } // Draw the folding arrow. - if (!p_item->disable_folding && !hide_folding && p_item->first_child && p_item->get_visible_child_count() != 0) { //has visible children, draw the guide box + if (!p_item->disable_folding && !hide_folding && p_item->first_child && p_item->get_visible_child_count() != 0) { // Has visible children, draw the guide box. Ref arrow; @@ -2620,7 +2607,7 @@ int Tree::draw_item(const Point2i &p_pos, const Point2 &p_draw_ofs, const Size2 children_pos.y += htotal; } - if (!p_item->collapsed) { /* if not collapsed, check the children */ + if (!p_item->collapsed) { // If not collapsed, check the children. TreeItem *c = p_item->first_child; int base_ofs = children_pos.y - theme_cache.offset.y + p_draw_ofs.y; @@ -2845,7 +2832,6 @@ void Tree::select_single_item(TreeItem *p_selected, TreeItem *p_current, int p_c } c.selected = false; } - //p_current->deselected_signal.call(p_col); } } } @@ -2892,7 +2878,7 @@ void Tree::_range_click_timeout() { cache.rtl = is_layout_rtl(); - propagate_mouse_activated = false; // done from outside, so signal handler can't clear the tree in the middle of emit (which is a common case) + propagate_mouse_activated = false; // Done from outside, so signal handler can't clear the tree in the middle of emit (which is a common case). blocked++; propagate_mouse_event(pos + theme_cache.offset, 0, 0, x_limit + theme_cache.offset.width, false, root, MouseButton::LEFT, mb); blocked--; @@ -2932,8 +2918,7 @@ int Tree::propagate_mouse_event(const Point2i &p_pos, int x_ofs, int y_ofs, int bool skip = (p_item == root && hide_root); if (!skip && p_pos.y < item_h) { - // check event! - + // Check event! if (range_click_timer->get_time_left() > 0 && p_item != range_item_last) { return -1; } @@ -2998,10 +2983,10 @@ int Tree::propagate_mouse_event(const Point2i &p_pos, int x_ofs, int y_ofs, int bool already_cursor = (p_item == selected_item) && col == selected_col; if (p_button == MouseButton::LEFT || (p_button == MouseButton::RIGHT && allow_rmb_select)) { - /* process selection */ + // Process selection. - if (p_double_click && (!c.editable || c.mode == TreeItem::CELL_MODE_CUSTOM || c.mode == TreeItem::CELL_MODE_ICON /*|| c.mode==TreeItem::CELL_MODE_CHECK*/)) { //it's confusing for check - // Emits the "item_activated" signal. + if (p_double_click && (!c.editable || c.mode == TreeItem::CELL_MODE_CUSTOM || c.mode == TreeItem::CELL_MODE_ICON)) { + // Emits the `item_activated` signal. propagate_mouse_activated = true; incr_search.clear(); @@ -3047,17 +3032,16 @@ int Tree::propagate_mouse_event(const Point2i &p_pos, int x_ofs, int y_ofs, int } if (!c.editable) { - return -1; // if cell is not editable, don't bother + return -1; // If cell is not editable, don't bother. } - /* editing */ - + // Editing. bool bring_up_editor = allow_reselect ? (c.selected && already_selected) : c.selected; String editor_text = c.text; switch (c.mode) { case TreeItem::CELL_MODE_STRING: { - //nothing in particular + // Nothing in particular. if (select_mode == SELECT_MULTI && (get_viewport()->get_processed_events_count() == focus_in_id || !already_cursor)) { bring_up_editor = false; @@ -3065,7 +3049,7 @@ int Tree::propagate_mouse_event(const Point2i &p_pos, int x_ofs, int y_ofs, int } break; case TreeItem::CELL_MODE_CHECK: { - bring_up_editor = false; //checkboxes are not edited with editor + bring_up_editor = false; // Checkboxes are not edited with editor. if (force_edit_checkbox_only_on_checkbox) { if (x < theme_cache.checked->get_width()) { p_item->set_checked(col, !c.checked); @@ -3076,12 +3060,10 @@ int Tree::propagate_mouse_event(const Point2i &p_pos, int x_ofs, int y_ofs, int item_edited(col, p_item, p_button); } click_handled = true; - //p_item->edited_signal.call(col); } break; case TreeItem::CELL_MODE_RANGE: { if (!c.text.is_empty()) { - //if (x >= (get_column_width(col)-item_h/2)) { popup_menu->clear(); for (int i = 0; i < c.text.get_slice_count(","); i++) { String s = c.text.get_slicec(',', i); @@ -3093,11 +3075,10 @@ int Tree::propagate_mouse_event(const Point2i &p_pos, int x_ofs, int y_ofs, int popup_menu->popup(); popup_edited_item = p_item; popup_edited_item_col = col; - //} bring_up_editor = false; } else { if (x >= (col_width - item_h / 2)) { - /* touching the combo */ + // Touching the combo. bool up = p_pos.y < (item_h / 2); if (p_button == MouseButton::LEFT) { @@ -3110,7 +3091,7 @@ int Tree::propagate_mouse_event(const Point2i &p_pos, int x_ofs, int y_ofs, int range_click_timer->start(); } else if (up != range_up_last) { - return -1; // break. avoid changing direction on mouse held + return -1; // Break. Avoid changing direction on mouse held. } p_item->set_range(col, c.val + (up ? 1.0 : -1.0) * c.step); @@ -3128,7 +3109,6 @@ int Tree::propagate_mouse_event(const Point2i &p_pos, int x_ofs, int y_ofs, int item_edited(col, p_item, p_button); } - //p_item->edited_signal.call(col); bring_up_editor = false; } else { @@ -3175,18 +3155,17 @@ int Tree::propagate_mouse_event(const Point2i &p_pos, int x_ofs, int y_ofs, int pressing_for_editor_text = editor_text; pressing_for_editor = true; - return -1; //select + return -1; // Select. } else { Point2i new_pos = p_pos; if (!skip) { x_ofs += theme_cache.item_margin; - //new_pos.x-=theme_cache.item_margin; y_ofs += item_h; new_pos.y -= item_h; } - if (!p_item->collapsed) { /* if not collapsed, check the children */ + if (!p_item->collapsed) { // If not collapsed, check the children. TreeItem *c = p_item->first_child; @@ -3194,7 +3173,7 @@ int Tree::propagate_mouse_event(const Point2i &p_pos, int x_ofs, int y_ofs, int int child_h = propagate_mouse_event(new_pos, x_ofs, y_ofs, x_limit, p_double_click, c, p_button, p_mod); if (child_h < 0) { - return -1; // break, stop propagating, no need to anymore + return -1; // Break, stop propagating, no need to anymore. } new_pos.y -= child_h; @@ -3208,12 +3187,12 @@ int Tree::propagate_mouse_event(const Point2i &p_pos, int x_ofs, int y_ofs, int } } - return item_h; // nothing found + return item_h; // Nothing found. } void Tree::_text_editor_popup_modal_close() { if (popup_edit_committed) { - return; // Already processed by LineEdit/TextEdit commit. + return; // Already processed by `LineEdit` / `TextEdit` commit. } if (popup_editor->get_hide_reason() == Popup::HIDE_REASON_CANCELED) { @@ -3237,7 +3216,7 @@ void Tree::_text_editor_popup_modal_close() { void Tree::_text_editor_gui_input(const Ref &p_event) { if (popup_edit_committed) { - return; // Already processed by _text_editor_popup_modal_close + return; // Already processed by `_text_editor_popup_modal_close`. } if (popup_editor->get_hide_reason() == Popup::HIDE_REASON_CANCELED) { @@ -3279,7 +3258,7 @@ void Tree::_apply_multiline_edit() { void Tree::_line_editor_submit(String p_text) { if (popup_edit_committed) { - return; // Already processed by _text_editor_popup_modal_close + return; // Already processed by _text_editor_popup_modal_close. } if (popup_editor->get_hide_reason() == Popup::HIDE_REASON_CANCELED) { @@ -3301,7 +3280,6 @@ void Tree::_line_editor_submit(String p_text) { switch (c.mode) { case TreeItem::CELL_MODE_STRING: { c.text = p_text; - //popup_edited_item->edited_signal.call( popup_edited_item_col ); } break; case TreeItem::CELL_MODE_RANGE: { c.val = p_text.to_float(); @@ -3313,7 +3291,6 @@ void Tree::_line_editor_submit(String p_text) { } else if (c.val > c.max) { c.val = c.max; } - //popup_edited_item->edited_signal.call( popup_edited_item_col ); } break; default: { ERR_FAIL(); @@ -3349,7 +3326,6 @@ void Tree::popup_select(int p_option) { } popup_edited_item->cells.write[popup_edited_item_col].val = p_option; - //popup_edited_item->edited_signal.call( popup_edited_item_col ); queue_redraw(); item_edited(popup_edited_item_col, popup_edited_item); } @@ -3359,14 +3335,14 @@ void Tree::_go_left() { if (selected_item->get_first_child() != nullptr && !selected_item->is_collapsed()) { selected_item->set_collapsed(true); } else { - if (columns.size() == 1) { // goto parent with one column + if (columns.size() == 1) { // Goto parent with one column. TreeItem *parent = selected_item->get_parent(); if (selected_item != get_root() && parent && parent->is_selectable(selected_col) && !(hide_root && parent == get_root())) { select_single_item(parent, get_root(), selected_col); } } else if (selected_item->get_prev_visible()) { selected_col = columns.size() - 1; - _go_up(); // go to upper column if possible + _go_up(); // Go to upper column if possible. } } } else { @@ -3427,7 +3403,7 @@ void Tree::_go_up() { prev = prev->get_prev_visible(); } if (!prev) { - return; // do nothing.. + return; // Do nothing. } prev->select(col); } @@ -3461,7 +3437,7 @@ void Tree::_go_down() { next = next->get_next_visible(); } if (!next) { - return; // do nothing.. + return; // Do nothing. } next->select(col); } @@ -3607,7 +3583,7 @@ void Tree::gui_input(const Ref &p_event) { next = next->get_next_visible(); } if (!next) { - return; // do nothing.. + return; // Do nothing. } next->select(selected_col); } @@ -3645,7 +3621,7 @@ void Tree::gui_input(const Ref &p_event) { prev = prev->get_prev_visible(); } if (!prev) { - return; // do nothing.. + return; // Do nothing. } prev->select(selected_col); } @@ -3666,7 +3642,7 @@ void Tree::gui_input(const Ref &p_event) { accept_event(); } else if (p_event->is_action("ui_accept") && p_event->is_pressed()) { if (selected_item) { - //bring up editor if possible + // Bring up editor if possible. if (!edit_selected()) { emit_signal(SNAME("item_activated")); incr_search.clear(); @@ -3675,7 +3651,7 @@ void Tree::gui_input(const Ref &p_event) { accept_event(); } - if (allow_search && k.is_valid()) { // Incremental search + if (allow_search && k.is_valid()) { // Incremental search. if (!k->is_pressed()) { return; @@ -3710,7 +3686,7 @@ void Tree::gui_input(const Ref &p_event) { bool rtl = is_layout_rtl(); if (pressing_for_editor && popup_pressing_edited_item && !popup_pressing_edited_item->cells.is_empty() && (popup_pressing_edited_item->get_cell_mode(popup_pressing_edited_item_column) == TreeItem::CELL_MODE_RANGE)) { - /* This needs to happen now, because the popup can be closed when pressing another item, and must remain the popup edited item until it actually closes */ + // This needs to happen now, because the popup can be closed when pressing another item, and must remain the popup edited item until it actually closes. popup_edited_item = popup_pressing_edited_item; popup_edited_item_col = popup_pressing_edited_item_column; @@ -3718,7 +3694,7 @@ void Tree::gui_input(const Ref &p_event) { popup_pressing_edited_item_column = -1; if (!range_drag_enabled) { - //range drag + // Range drag. Vector2 cpos = mm->get_position(); if (rtl) { cpos.x = get_size().width - cpos.x; @@ -3802,7 +3778,7 @@ void Tree::gui_input(const Ref &p_event) { icon_size_x = icon_region.size.width; } } - // Icon is treated as if it is outside of the rect so that double clicking on it will emit the item_icon_double_clicked signal. + // Icon is treated as if it is outside of the rect so that double clicking on it will emit the `item_icon_double_clicked` signal. if (rtl) { mpos.x = get_size().width - (mpos.x + icon_size_x); } else { @@ -3924,8 +3900,8 @@ void Tree::gui_input(const Ref &p_event) { if (!click_handled) { drag_speed = 0; drag_accum = 0; - //last_drag_accum=0; drag_from = v_scroll->get_value(); + drag_touching = DisplayServer::get_singleton()->is_touchscreen_available(); drag_touching_deaccel = false; if (drag_touching) { @@ -4051,7 +4027,7 @@ void Tree::_determine_hovered_item() { if (it != old_item || col != old_column) { if (old_item && old_column >= old_item->cells.size()) { - // Columns may have changed since last redraw(). + // Columns may have changed since last `redraw()`. queue_redraw(); } else { // Only need to update if mouse enters/exits a button. @@ -4065,7 +4041,6 @@ void Tree::_determine_hovered_item() { } // Reduce useless redraw calls. - bool hovered_cell_button_changed = (cache.hover_button_index_in_column != old_button_index_in_column); bool hovered_column_changed = (cache.hover_column != old_column); @@ -4130,7 +4105,7 @@ bool Tree::edit_selected(bool p_force_edit) { Rect2 popup_rect; int value_editor_height = c.mode == TreeItem::CELL_MODE_RANGE ? value_editor->get_minimum_size().height : 0; - // "floor()" centers vertically. + // `floor()` centers vertically. Vector2 ofs(0, Math::floor((MAX(line_editor->get_minimum_size().height, rect.size.height - value_editor_height) - rect.size.height) / 2)); // Account for icon. @@ -4442,7 +4417,7 @@ void Tree::_notification(int p_what) { } if (show_column_titles) { - //title buttons + // Title buttons. int ofs2 = theme_cache.panel_style->get_margin(SIDE_LEFT); for (int i = 0; i < columns.size(); i++) { Ref sb = (cache.click_type == Cache::CLICK_TITLE && cache.click_index == i) ? theme_cache.title_button_pressed : ((cache.hover_header_row && cache.hover_header_column == i) ? theme_cache.title_button_hover : theme_cache.title_button); @@ -4452,7 +4427,7 @@ void Tree::_notification(int p_what) { } sb->draw(ci, tbrect); ofs2 += tbrect.size.width; - //text + // Text. int clip_w = tbrect.size.width - sb->get_minimum_size().width; columns.write[i].text_buf->set_width(clip_w); columns.write[i].cached_minimum_width_dirty = true; @@ -4614,7 +4589,7 @@ void Tree::item_selected(int p_column, TreeItem *p_item) { } p_item->cells.write[p_column].selected = true; - //emit_signal(SNAME("multi_selected"),p_item,p_column,true); - NO this is for TreeItem::select + //emit_signal(SNAME("multi_selected"),p_item,p_column,true); - NO this is for `TreeItem::select` selected_col = p_column; selected_item = p_item; @@ -5014,7 +4989,7 @@ void Tree::ensure_cursor_is_visible() { return; // Nothing under cursor. } - // Note: Code below similar to Tree::scroll_to_item(), in case of bug fix both. + // Note: Code below similar to `Tree::scroll_to_item()`, in case of bug fix both. const Size2 area_size = _get_content_rect().size; int y_offset = get_item_offset(selected_item); @@ -5034,7 +5009,7 @@ void Tree::ensure_cursor_is_visible() { } } - if (select_mode != SELECT_ROW) { // Cursor always at col 0 in this mode. + if (select_mode != SELECT_ROW) { // Cursor always at column 0 in this mode. int x_offset = 0; for (int i = 0; i < selected_col; i++) { x_offset += get_column_width(i); @@ -5064,7 +5039,7 @@ Rect2 Tree::get_item_rect(TreeItem *p_item, int p_column, int p_button) const { ERR_FAIL_INDEX_V(p_column, columns.size(), Rect2()); } if (p_button != -1) { - ERR_FAIL_COND_V(p_column == -1, Rect2()); // pass a column if you want to pass a button + ERR_FAIL_COND_V(p_column == -1, Rect2()); // Pass a column if you want to pass a button. ERR_FAIL_INDEX_V(p_button, p_item->cells[p_column].buttons.size(), Rect2()); } @@ -5117,7 +5092,7 @@ Rect2 Tree::get_item_rect(TreeItem *p_item, int p_column, int p_button) const { if (r.position.x + r.size.x < content_rect_end_x) { return Rect2(ofst, Size2(size.x, r.size.y)); } - // Button block can be outside of content_rect + // Button block can be outside of `content_rect`. if (content_rect_end_x - (r.position.x + theme_cache.h_separation) < buttons_width) { return Rect2(r.position + Point2(theme_cache.h_separation + (buttons_width - ((r.position.x + r.size.x) - ofst.x)), 0), Size2(size.x, r.size.y)); } @@ -5229,7 +5204,7 @@ void Tree::scroll_to_item(TreeItem *p_item, bool p_center_on_item) { update_scrollbars(); - // Note: Code below similar to Tree::ensure_cursor_is_visible(), in case of bug fix both. + // Note: Code below similar to `Tree::ensure_cursor_is_visible()`, in case of bug fix both. const Size2 area_size = _get_content_rect().size; int y_offset = get_item_offset(p_item); @@ -5361,7 +5336,7 @@ TreeItem *Tree::get_item_with_metadata(const Variant &p_find, int p_column) cons } void Tree::_do_incr_search(const String &p_add) { - uint64_t time = OS::get_singleton()->get_ticks_usec() / 1000; // convert to msec + uint64_t time = OS::get_singleton()->get_ticks_usec() / 1000; // Convert to msec. uint64_t diff = time - last_keypress; if (diff > uint64_t(GLOBAL_GET("gui/timers/incremental_search_max_interval_msec"))) { incr_search = p_add; @@ -5429,7 +5404,7 @@ TreeItem *Tree::_find_item_at_pos(TreeItem *p_item, const Point2 &p_pos, int &r_ } if (p_item->is_collapsed() || !p_item->is_visible_in_tree()) { - return nullptr; // do not try children, it's collapsed + return nullptr; // Do not try children, it's collapsed. } TreeItem *n = p_item->get_first_child(); @@ -5447,10 +5422,10 @@ TreeItem *Tree::_find_item_at_pos(TreeItem *p_item, const Point2 &p_pos, int &r_ return nullptr; } -// When on a button, r_index is valid. -// When on an item, both r_item and r_column are valid. -// Otherwise, all output arguments are invalid. void Tree::_find_button_at_pos(const Point2 &p_pos, TreeItem *&r_item, int &r_column, int &r_index, int &r_section) const { + // When on a button, `r_index` is valid. + // When on an item, both `r_item` and `r_column` are valid. + // Otherwise, all output arguments are invalid. r_item = nullptr; r_column = -1; r_index = -1; diff --git a/scene/gui/tree.h b/scene/gui/tree.h index e1cf1095ace..784c264663b 100644 --- a/scene/gui/tree.h +++ b/scene/gui/tree.h @@ -45,11 +45,11 @@ class TreeItem : public Object { public: enum TreeCellMode { - CELL_MODE_STRING, ///< just a string - CELL_MODE_CHECK, ///< string + check - CELL_MODE_RANGE, ///< Contains a range - CELL_MODE_ICON, ///< Contains an icon, not editable - CELL_MODE_CUSTOM, ///< Contains a custom value, show a string, and an edit button + CELL_MODE_STRING, + CELL_MODE_CHECK, + CELL_MODE_RANGE, + CELL_MODE_ICON, + CELL_MODE_CUSTOM, }; private: @@ -127,21 +127,21 @@ private: Vector cells; - bool collapsed = false; // won't show children + bool collapsed = false; // Won't show children. bool visible = true; bool parent_visible_in_tree = true; bool disable_folding = false; int custom_min_height = 0; - TreeItem *parent = nullptr; // parent item - TreeItem *prev = nullptr; // previous in list - TreeItem *next = nullptr; // next in list + TreeItem *parent = nullptr; // Parent item. + TreeItem *prev = nullptr; // Previous in list. + TreeItem *next = nullptr; // Next in list. TreeItem *first_child = nullptr; TreeItem *last_child = nullptr; Vector children_cache; - bool is_root = false; // for tree root - Tree *tree = nullptr; // tree (for reference) + bool is_root = false; // For tree root. + Tree *tree = nullptr; // Tree (for reference). TreeItem(Tree *p_tree); @@ -190,7 +190,7 @@ private: protected: static void _bind_methods(); - // Bind helpers + // Bind helpers. Dictionary _get_range_config(int p_column) { Dictionary d; double min = 0.0, max = 0.0, step = 0.0; @@ -206,19 +206,19 @@ protected: void _call_recursive_bind(const Variant **p_args, int p_argcount, Callable::CallError &r_error); public: - /* cell mode */ + // Cell mode. void set_cell_mode(int p_column, TreeCellMode p_mode); TreeCellMode get_cell_mode(int p_column) const; - /* auto translate mode */ + // Auto translate mode. void set_auto_translate_mode(int p_column, Node::AutoTranslateMode p_mode); Node::AutoTranslateMode get_auto_translate_mode(int p_column) const; - /* multiline editable */ + // Multiline editable. void set_edit_multiline(int p_column, bool p_multiline); bool is_edit_multiline(int p_column) const; - /* check mode */ + // Check mode. void set_checked(int p_column, bool p_checked); void set_indeterminate(int p_column, bool p_indeterminate); bool is_checked(int p_column) const; @@ -291,8 +291,7 @@ public: void set_button_disabled(int p_column, int p_index, bool p_disabled); bool is_button_disabled(int p_column, int p_index) const; - /* range works for mode number or mode combo */ - + // Range works for mode number or mode combo. void set_range(int p_column, double p_value); double get_range(int p_column) const; @@ -366,8 +365,7 @@ public: Size2 get_minimum_size(int p_column); - /* Item manipulation */ - + // Item manipulation. TreeItem *create_child(int p_index = -1); void add_child(TreeItem *p_item); void remove_child(TreeItem *p_item); @@ -459,9 +457,6 @@ private: bool propagate_mouse_activated = false; - //TreeItem *cursor_item; - //int cursor_column; - Rect2 custom_popup_rect; int edited_col = -1; int selected_col = -1; @@ -519,7 +514,6 @@ private: void update_column(int p_col); void update_item_cell(TreeItem *p_item, int p_col) const; void update_item_cache(TreeItem *p_item) const; - //void draw_item_text(String p_text,const Ref& p_icon,int p_icon_max_w,bool p_tool,Rect2i p_rect,const Color& p_color); void draw_item_rect(TreeItem::Cell &p_cell, const Rect2i &p_rect, const Color &p_color, const Color &p_icon_color, int p_ol_size, const Color &p_ol_color); int draw_item(const Point2i &p_pos, const Point2 &p_draw_ofs, const Size2 &p_draw_size, TreeItem *p_item, int &r_self_height); void select_single_item(TreeItem *p_selected, TreeItem *p_current, int p_col, TreeItem *p_prev = nullptr, bool *r_in_range = nullptr, bool p_force_deselect = false); @@ -663,7 +657,6 @@ private: void update_scrollbars(); Rect2 search_item_rect(TreeItem *p_from, TreeItem *p_item); - //Rect2 get_item_rect(TreeItem *p_item); uint64_t last_keypress = 0; String incr_search; bool cursor_can_exit_tree = true; @@ -685,17 +678,9 @@ private: FindColumnButtonResult _find_column_and_button_at_pos(int p_x, const TreeItem *p_item, int p_x_ofs, int p_x_limit) const; - /* float drag_speed; - float drag_accum; - - float last_drag_accum; - float last_drag_time; - float time_since_motion;*/ - float drag_speed = 0.0; float drag_from = 0.0; float drag_accum = 0.0; - Vector2 last_speed; bool drag_touching = false; bool drag_touching_deaccel = false; bool click_handled = false;