ListView.cpp 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2022, the SerenityOS developers.
  4. *
  5. * SPDX-License-Identifier: BSD-2-Clause
  6. */
  7. #include <LibGUI/ListView.h>
  8. #include <LibGUI/Model.h>
  9. #include <LibGUI/Painter.h>
  10. #include <LibGUI/Scrollbar.h>
  11. #include <LibGfx/Palette.h>
  12. REGISTER_WIDGET(GUI, ListView)
  13. namespace GUI {
  14. ListView::ListView()
  15. {
  16. set_fill_with_background_color(true);
  17. set_background_role(ColorRole::Base);
  18. set_foreground_role(ColorRole::BaseText);
  19. set_searchable(true);
  20. }
  21. ListView::~ListView() = default;
  22. void ListView::select_all()
  23. {
  24. selection().clear();
  25. for (int item_index = 0; item_index < item_count(); ++item_index) {
  26. auto index = model()->index(item_index, m_model_column);
  27. selection().add(index);
  28. }
  29. }
  30. void ListView::update_content_size()
  31. {
  32. if (!model())
  33. return set_content_size({});
  34. int content_width = 0;
  35. for (int row = 0, row_count = model()->row_count(); row < row_count; ++row) {
  36. auto text = model()->index(row, m_model_column).data();
  37. content_width = max(content_width, font().width(text.to_deprecated_string()) + horizontal_padding() * 2);
  38. }
  39. content_width = max(content_width, widget_inner_rect().width());
  40. int content_height = item_count() * item_height();
  41. set_content_size({ content_width, content_height });
  42. }
  43. void ListView::resize_event(ResizeEvent& event)
  44. {
  45. update_content_size();
  46. AbstractView::resize_event(event);
  47. }
  48. void ListView::layout_relevant_change_occurred()
  49. {
  50. update_content_size();
  51. AbstractView::layout_relevant_change_occurred();
  52. }
  53. void ListView::model_did_update(unsigned flags)
  54. {
  55. AbstractView::model_did_update(flags);
  56. update_content_size();
  57. update();
  58. }
  59. Gfx::IntRect ListView::content_rect(int row) const
  60. {
  61. return { 0, row * item_height(), content_width(), item_height() };
  62. }
  63. Gfx::IntRect ListView::content_rect(ModelIndex const& index) const
  64. {
  65. return content_rect(index.row());
  66. }
  67. ModelIndex ListView::index_at_event_position(Gfx::IntPoint point) const
  68. {
  69. VERIFY(model());
  70. auto adjusted_position = this->adjusted_position(point);
  71. for (int row = 0, row_count = model()->row_count(); row < row_count; ++row) {
  72. if (!content_rect(row).contains(adjusted_position))
  73. continue;
  74. return model()->index(row, m_model_column);
  75. }
  76. return {};
  77. }
  78. Gfx::IntPoint ListView::adjusted_position(Gfx::IntPoint position) const
  79. {
  80. return position.translated(horizontal_scrollbar().value() - frame_thickness(), vertical_scrollbar().value() - frame_thickness());
  81. }
  82. void ListView::paint_list_item(Painter& painter, int row_index, int painted_item_index)
  83. {
  84. bool is_selected_row = selection().contains_row(row_index);
  85. int y = painted_item_index * item_height();
  86. Color background_color;
  87. if (is_selected_row) {
  88. background_color = is_focused() ? palette().selection() : palette().inactive_selection();
  89. } else {
  90. Color row_fill_color = palette().color(background_role());
  91. if (alternating_row_colors() && (painted_item_index % 2)) {
  92. background_color = row_fill_color.darkened(0.8f);
  93. } else {
  94. background_color = row_fill_color;
  95. }
  96. }
  97. Gfx::IntRect row_rect(0, y, content_width(), item_height());
  98. painter.fill_rect(row_rect, background_color);
  99. auto index = model()->index(row_index, m_model_column);
  100. auto data = index.data();
  101. auto font = font_for_index(index);
  102. if (data.is_bitmap()) {
  103. painter.blit(row_rect.location(), data.as_bitmap(), data.as_bitmap().rect());
  104. } else if (data.is_icon()) {
  105. if (auto bitmap = data.as_icon().bitmap_for_size(16)) {
  106. auto opacity = index.data(ModelRole::IconOpacity).as_float_or(1.0f);
  107. painter.blit(row_rect.location(), *bitmap, bitmap->rect(), opacity);
  108. }
  109. } else {
  110. auto text_rect = row_rect;
  111. text_rect.translate_by(horizontal_padding(), 0);
  112. text_rect.set_width(text_rect.width() - horizontal_padding() * 2);
  113. auto text_alignment = index.data(ModelRole::TextAlignment).to_text_alignment(Gfx::TextAlignment::CenterLeft);
  114. draw_item_text(painter, index, is_selected_row, text_rect, data.to_deprecated_string(), font, text_alignment, Gfx::TextElision::None);
  115. }
  116. }
  117. void ListView::paint_event(PaintEvent& event)
  118. {
  119. Frame::paint_event(event);
  120. if (!model())
  121. return;
  122. Painter painter(*this);
  123. painter.add_clip_rect(frame_inner_rect());
  124. painter.add_clip_rect(event.rect());
  125. painter.translate(frame_thickness(), frame_thickness());
  126. painter.translate(-horizontal_scrollbar().value(), -vertical_scrollbar().value());
  127. int exposed_width = max(content_size().width(), width());
  128. int painted_item_index = 0;
  129. for (int row_index = 0; row_index < model()->row_count(); ++row_index) {
  130. paint_list_item(painter, row_index, painted_item_index);
  131. ++painted_item_index;
  132. };
  133. Gfx::IntRect unpainted_rect(0, painted_item_index * item_height(), exposed_width, height());
  134. if (fill_with_background_color())
  135. painter.fill_rect(unpainted_rect, palette().color(background_role()));
  136. }
  137. int ListView::item_count() const
  138. {
  139. if (!model())
  140. return 0;
  141. return model()->row_count();
  142. }
  143. void ListView::mousemove_event(MouseEvent& event)
  144. {
  145. auto previous_hovered_index = m_hovered_index;
  146. AbstractView::mousemove_event(event);
  147. if (hover_highlighting() && previous_hovered_index != m_hovered_index)
  148. set_cursor(m_hovered_index, SelectionUpdate::Set);
  149. }
  150. void ListView::keydown_event(KeyEvent& event)
  151. {
  152. if (!model())
  153. return AbstractView::keydown_event(event);
  154. if (event.key() == KeyCode::Key_Escape) {
  155. if (on_escape_pressed)
  156. on_escape_pressed();
  157. return;
  158. }
  159. AbstractView::keydown_event(event);
  160. }
  161. void ListView::move_cursor_relative(int steps, SelectionUpdate selection_update)
  162. {
  163. if (!model())
  164. return;
  165. auto& model = *this->model();
  166. ModelIndex new_index;
  167. if (cursor_index().is_valid()) {
  168. auto row = cursor_index().row();
  169. if (steps > 0) {
  170. if (row + steps >= model.row_count())
  171. row = model.row_count() - 1;
  172. else
  173. row += steps;
  174. } else if (steps < 0) {
  175. if (row < -steps)
  176. row = 0;
  177. else
  178. row += steps;
  179. }
  180. new_index = model.index(row, cursor_index().column());
  181. } else {
  182. new_index = model.index(0, 0);
  183. }
  184. set_cursor(new_index, selection_update);
  185. }
  186. void ListView::move_cursor(CursorMovement movement, SelectionUpdate selection_update)
  187. {
  188. if (!model())
  189. return;
  190. auto& model = *this->model();
  191. if (!cursor_index().is_valid()) {
  192. set_cursor(model.index(0, 0), SelectionUpdate::Set);
  193. return;
  194. }
  195. ModelIndex new_index;
  196. switch (movement) {
  197. case CursorMovement::Up:
  198. new_index = model.index(cursor_index().row() - 1, cursor_index().column());
  199. break;
  200. case CursorMovement::Down:
  201. new_index = model.index(cursor_index().row() + 1, cursor_index().column());
  202. break;
  203. case CursorMovement::Home:
  204. new_index = model.index(0, 0);
  205. break;
  206. case CursorMovement::End:
  207. new_index = model.index(model.row_count() - 1, 0);
  208. break;
  209. case CursorMovement::PageUp: {
  210. int items_per_page = visible_content_rect().height() / item_height();
  211. new_index = model.index(max(0, cursor_index().row() - items_per_page), cursor_index().column());
  212. break;
  213. }
  214. case CursorMovement::PageDown: {
  215. int items_per_page = visible_content_rect().height() / item_height();
  216. new_index = model.index(min(model.row_count() - 1, cursor_index().row() + items_per_page), cursor_index().column());
  217. break;
  218. }
  219. default:
  220. break;
  221. }
  222. if (new_index.is_valid())
  223. set_cursor(new_index, selection_update);
  224. }
  225. void ListView::scroll_into_view(ModelIndex const& index, bool scroll_horizontally, bool scroll_vertically)
  226. {
  227. if (!model())
  228. return;
  229. AbstractScrollableWidget::scroll_into_view(content_rect(index.row()), scroll_horizontally, scroll_vertically);
  230. }
  231. }