1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
//! Wraps `NSView` and `UIView` across platforms.
//!
//! This implementation errs towards the `UIView` side of things, and mostly acts as a wrapper to
//! bring `NSView` to the modern era. It does this by flipping the coordinate system to be what
//! people expect in 2020, and layer-backing all views by default.
//!
//! Views implement Autolayout, which enable you to specify how things should appear on the screen.
//!
//! ```rust,no_run
//! use cacao::color::Color;
//! use cacao::layout::{Layout, LayoutConstraint};
//! use cacao::view::View;
//! use cacao::appkit::window::{Window, WindowDelegate};
//!
//! #[derive(Default)]
//! struct AppWindow {
//! content: View,
//! red: View,
//! window: Window
//! }
//!
//! impl WindowDelegate for AppWindow {
//! const NAME: &'static str = "RootView";
//! fn did_load(&mut self, window: Window) {
//! window.set_minimum_content_size(300., 300.);
//! self.window = window;
//!
//! self.red.set_background_color(Color::rgb(224, 82, 99));
//! self.content.add_subview(&self.red);
//!
//! self.window.set_content_view(&self.content);
//!
//! LayoutConstraint::activate(&[
//! self.red.top.constraint_equal_to(&self.content.top).offset(16.),
//! self.red.leading.constraint_equal_to(&self.content.leading).offset(16.),
//! self.red.trailing.constraint_equal_to(&self.content.trailing).offset(-16.),
//! self.red.bottom.constraint_equal_to(&self.content.bottom).offset(-16.),
//! ]);
//! }
//! }
//! ```
//!
//! For more information on Autolayout, view the module or check out the examples folder.
use std::collections::HashMap;
use core_graphics::base::CGFloat;
use objc::runtime::{Class, Object};
use objc::{class, msg_send, sel, sel_impl};
use objc_id::ShareId;
use crate::color::Color;
use crate::foundation::{id, nil, NSArray, NSInteger, NSString, NSUInteger, NO, YES};
use crate::layout::Layout;
#[cfg(feature = "autolayout")]
use crate::layout::{LayoutAnchorDimension, LayoutAnchorX, LayoutAnchorY};
use crate::objc_access::ObjcAccess;
use crate::scrollview::ScrollView;
use crate::utils::properties::{ObjcProperty, PropertyNullable};
use crate::utils::{os, CGSize, CellFactory};
use crate::view::{ViewAnimatorProxy, ViewDelegate};
#[cfg(feature = "appkit")]
use crate::appkit::menu::MenuItem;
#[cfg(feature = "appkit")]
mod appkit;
#[cfg(feature = "appkit")]
use appkit::{register_listview_class, register_listview_class_with_delegate};
//#[cfg(target_os = "ios")]
//mod ios;
//#[cfg(target_os = "ios")]
//use ios::{register_view_class, register_view_class_with_delegate};
mod enums;
pub use enums::{RowAnimation, RowEdge};
mod traits;
pub use traits::ListViewDelegate;
mod row;
pub use row::ListViewRow;
mod actions;
pub use actions::{RowAction, RowActionStyle};
pub(crate) static LISTVIEW_DELEGATE_PTR: &str = "rstListViewDelegatePtr";
use std::any::Any;
use std::sync::{Arc, RwLock};
use std::cell::RefCell;
use std::rc::Rc;
/// A helper method for instantiating view classes and applying default settings to them.
fn common_init(class: *const Class) -> id {
unsafe {
// Note: we do *not* enable AutoLayout here as we're by default placing this in a scroll
// view, and we want it to just do its thing.
let tableview: id = msg_send![class, new];
// Let's... make NSTableView into UITableView-ish.
#[cfg(feature = "appkit")]
{
// @TODO: Clean this up in a dealloc method.
let menu: id = msg_send![class!(NSMenu), new];
let _: () = msg_send![menu, setDelegate: tableview];
let _: () = msg_send![tableview, setMenu: menu];
let _: () = msg_send![tableview, setWantsLayer: YES];
let _: () = msg_send![tableview, setUsesAutomaticRowHeights: YES];
let _: () = msg_send![tableview, setFloatsGroupRows: YES];
//let _: () = msg_send![tableview, setIntercellSpacing:CGSize::new(0., 0.)];
let _: () = msg_send![tableview, setColumnAutoresizingStyle:1];
//msg_send![tableview, setSelectionHighlightStyle:-1];
//let _: () = msg_send![tableview, setAllowsMultipleSelection:NO];
let _: () = msg_send![tableview, setHeaderView: nil];
// NSTableView requires at least one column to be manually added if doing so by code.
let identifier = NSString::no_copy("CacaoListViewColumn");
let default_column_alloc: id = msg_send![class!(NSTableColumn), new];
let default_column: id = msg_send![default_column_alloc, initWithIdentifier:&*identifier];
let _: () = msg_send![default_column, setResizingMask:(1<<0)];
let _: () = msg_send![tableview, addTableColumn: default_column];
}
tableview
}
}
#[derive(Debug)]
pub struct ListView<T = ()> {
/// Internal map of cell identifers/vendors. These are used for handling dynamic cell
/// allocation and reuse, which is necessary for an "infinite" listview.
cell_factory: CellFactory,
menu: PropertyNullable<Vec<MenuItem>>,
/// A pointer to the Objective-C runtime view controller.
pub objc: ObjcProperty,
/// An object that supports limited animations. Can be cloned into animation closures.
pub animator: ViewAnimatorProxy,
/// In AppKit, we need to manage the NSScrollView ourselves. It's a bit
/// more old school like that...
///
/// In iOS, this is a pointer to the UITableView-owned UIScrollView.
pub scrollview: ScrollView,
/// A pointer to the delegate for this view.
pub delegate: Option<Box<T>>,
/// A pointer to the Objective-C runtime top layout constraint.
#[cfg(feature = "autolayout")]
pub top: LayoutAnchorY,
/// A pointer to the Objective-C runtime leading layout constraint.
#[cfg(feature = "autolayout")]
pub leading: LayoutAnchorX,
/// A pointer to the Objective-C runtime left layout constraint.
#[cfg(feature = "autolayout")]
pub left: LayoutAnchorX,
/// A pointer to the Objective-C runtime trailing layout constraint.
#[cfg(feature = "autolayout")]
pub trailing: LayoutAnchorX,
/// A pointer to the Objective-C runtime right layout constraint.
#[cfg(feature = "autolayout")]
pub right: LayoutAnchorX,
/// A pointer to the Objective-C runtime bottom layout constraint.
#[cfg(feature = "autolayout")]
pub bottom: LayoutAnchorY,
/// A pointer to the Objective-C runtime width layout constraint.
#[cfg(feature = "autolayout")]
pub width: LayoutAnchorDimension,
/// A pointer to the Objective-C runtime height layout constraint.
#[cfg(feature = "autolayout")]
pub height: LayoutAnchorDimension,
/// A pointer to the Objective-C runtime center X layout constraint.
#[cfg(feature = "autolayout")]
pub center_x: LayoutAnchorX,
/// A pointer to the Objective-C runtime center Y layout constraint.
#[cfg(feature = "autolayout")]
pub center_y: LayoutAnchorY
}
impl Default for ListView {
fn default() -> Self {
ListView::new()
}
}
impl ListView {
/// @TODO: The hell is this for?
pub fn new() -> Self {
let class = register_listview_class();
let view = common_init(class);
#[cfg(feature = "appkit")]
let scrollview = {
let sview = ScrollView::new();
sview.objc.with_mut(|obj| unsafe {
let _: () = msg_send![obj, setDocumentView: view];
});
sview
};
// For AppKit, we need to use the NSScrollView anchor points, not the NSTableView.
// @TODO: Fix this with proper mutable access.
#[cfg(all(feature = "appkit", feature = "autolayout"))]
let anchor_view: id = scrollview.objc.get(|obj| unsafe { msg_send![obj, self] });
//#[cfg(all(feature = "uikit", feature = "autolayout"))]
//let anchor_view: id = view;
ListView {
cell_factory: CellFactory::new(),
menu: PropertyNullable::default(),
delegate: None,
#[cfg(feature = "autolayout")]
top: LayoutAnchorY::top(anchor_view),
#[cfg(feature = "autolayout")]
left: LayoutAnchorX::left(anchor_view),
#[cfg(feature = "autolayout")]
leading: LayoutAnchorX::leading(anchor_view),
#[cfg(feature = "autolayout")]
right: LayoutAnchorX::right(anchor_view),
#[cfg(feature = "autolayout")]
trailing: LayoutAnchorX::trailing(anchor_view),
#[cfg(feature = "autolayout")]
bottom: LayoutAnchorY::bottom(anchor_view),
#[cfg(feature = "autolayout")]
width: LayoutAnchorDimension::width(anchor_view),
#[cfg(feature = "autolayout")]
height: LayoutAnchorDimension::height(anchor_view),
#[cfg(feature = "autolayout")]
center_x: LayoutAnchorX::center(anchor_view),
#[cfg(feature = "autolayout")]
center_y: LayoutAnchorY::center(anchor_view),
// Note that AppKit needs this to be the ScrollView!
// @TODO: Figure out if there's a use case for exposing the inner tableview animator
// property...
animator: ViewAnimatorProxy::new(anchor_view),
objc: ObjcProperty::retain(view),
scrollview
}
}
}
impl<T> ListView<T>
where
T: ListViewDelegate + 'static
{
/// Initializes a new View with a given `ViewDelegate`. This enables you to respond to events
/// and customize the view as a module, similar to class-based systems.
pub fn with(delegate: T) -> ListView<T> {
let class = register_listview_class_with_delegate::<T>(&delegate);
let view = common_init(class);
let mut delegate = Box::new(delegate);
let cell = CellFactory::new();
unsafe {
let delegate_ptr: *const T = &*delegate;
(&mut *view).set_ivar(LISTVIEW_DELEGATE_PTR, delegate_ptr as usize);
let _: () = msg_send![view, setDelegate: view];
let _: () = msg_send![view, setDataSource: view];
};
#[cfg(feature = "appkit")]
let scrollview = {
let sview = ScrollView::new();
sview.objc.with_mut(|obj| unsafe {
let _: () = msg_send![obj, setDocumentView: view];
});
sview
};
// For AppKit, we need to use the NSScrollView anchor points, not the NSTableView.
#[cfg(all(feature = "appkit", feature = "autolayout"))]
let anchor_view: id = scrollview.objc.get(|obj| unsafe { msg_send![obj, self] });
//#[cfg(feature = "uikit")]
//let anchor_view = view;
let mut view = ListView {
cell_factory: cell,
menu: PropertyNullable::default(),
delegate: None,
objc: ObjcProperty::retain(view),
animator: ViewAnimatorProxy::new(anchor_view),
#[cfg(feature = "autolayout")]
top: LayoutAnchorY::top(anchor_view),
#[cfg(feature = "autolayout")]
left: LayoutAnchorX::left(anchor_view),
#[cfg(feature = "autolayout")]
leading: LayoutAnchorX::leading(anchor_view),
#[cfg(feature = "autolayout")]
right: LayoutAnchorX::right(anchor_view),
#[cfg(feature = "autolayout")]
trailing: LayoutAnchorX::trailing(anchor_view),
#[cfg(feature = "autolayout")]
bottom: LayoutAnchorY::bottom(anchor_view),
#[cfg(feature = "autolayout")]
width: LayoutAnchorDimension::width(anchor_view),
#[cfg(feature = "autolayout")]
height: LayoutAnchorDimension::height(anchor_view),
#[cfg(feature = "autolayout")]
center_x: LayoutAnchorX::center(anchor_view),
#[cfg(feature = "autolayout")]
center_y: LayoutAnchorY::center(anchor_view),
scrollview
};
(&mut delegate).did_load(view.clone_as_handle());
view.delegate = Some(delegate);
view
}
}
impl<T> ListView<T> {
/// An internal method that returns a clone of this object, sans references to the delegate or
/// callback pointer. We use this in calling `did_load()` - implementing delegates get a way to
/// reference, customize and use the view but without the trickery of holding pieces of the
/// delegate - the `View` is the only true holder of those.
pub fn clone_as_handle(&self) -> ListView {
ListView {
cell_factory: CellFactory::new(),
menu: self.menu.clone(),
delegate: None,
objc: self.objc.clone(),
animator: self.animator.clone(),
#[cfg(feature = "autolayout")]
top: self.top.clone(),
#[cfg(feature = "autolayout")]
leading: self.leading.clone(),
#[cfg(feature = "autolayout")]
left: self.left.clone(),
#[cfg(feature = "autolayout")]
trailing: self.trailing.clone(),
#[cfg(feature = "autolayout")]
right: self.right.clone(),
#[cfg(feature = "autolayout")]
bottom: self.bottom.clone(),
#[cfg(feature = "autolayout")]
width: self.width.clone(),
#[cfg(feature = "autolayout")]
height: self.height.clone(),
#[cfg(feature = "autolayout")]
center_x: self.center_x.clone(),
#[cfg(feature = "autolayout")]
center_y: self.center_y.clone(),
scrollview: self.scrollview.clone_as_handle()
}
}
/// Register a cell/row vendor function with an identifier. This is stored internally and used
/// for row-reuse.
pub fn register<F, R>(&self, identifier: &'static str, vendor: F)
where
F: Fn() -> R + 'static,
R: ViewDelegate + 'static
{
self.cell_factory.insert(identifier, vendor);
}
/// Dequeue a reusable cell. If one is not in the queue, will create and cache one for reuse.
pub fn dequeue<R: ViewDelegate + 'static>(&self, identifier: &'static str) -> ListViewRow<R> {
#[cfg(feature = "appkit")]
{
let key = NSString::new(identifier);
let cell: id = self
.objc
.get(|obj| unsafe { msg_send![obj, makeViewWithIdentifier:&*key owner:nil] });
if cell != nil {
ListViewRow::from_cached(cell)
} else {
let delegate: Box<R> = self.cell_factory.get(identifier);
let view = ListViewRow::with_boxed(delegate);
view.set_identifier(identifier);
view
}
}
}
/// Call this to set the background color for the backing layer.
pub fn set_background_color<C: AsRef<Color>>(&self, color: C) {
// @TODO: This is wrong.
self.objc.with_mut(|obj| unsafe {
let color = color.as_ref().cg_color();
let layer: id = msg_send![obj, layer];
let _: () = msg_send![layer, setBackgroundColor: color];
});
}
/// Sets the style for the underlying NSTableView. This property is only supported on macOS
/// 11.0+, and will always be `FullWidth` on anything older.
///
/// On non-macOS platforms, this method is a noop.
#[cfg(feature = "appkit")]
pub fn set_style(&self, style: crate::foundation::NSInteger) {
#[cfg(target_os = "macos")]
if os::is_minimum_version(11) {
self.objc.with_mut(|obj| unsafe {
let _: () = msg_send![obj, setStyle: style];
});
}
}
/// Set whether this control can appear with no row selected.
///
/// This defaults to `true`, but some AppKit pieces (e.g, a sidebar) may want this set to
/// `false`. This can be particularly useful when implementing a Source List style sidebar
/// view for navigation purposes.
#[cfg(feature = "appkit")]
pub fn set_allows_empty_selection(&self, allows: bool) {
self.objc.with_mut(|obj| unsafe {
let _: () = msg_send![obj, setAllowsEmptySelection:match allows {
true => YES,
false => NO
}];
});
}
/// Set the selection highlight style.
pub fn set_selection_highlight_style(&self, style: crate::foundation::NSInteger) {
self.objc.with_mut(|obj| unsafe {
let _: () = msg_send![obj, setSelectionHighlightStyle: style];
});
}
/// Select the rows at the specified indexes, optionally adding to any existing selections.
pub fn select_row_indexes(&self, indexes: &[usize], extends_existing: bool) {
unsafe {
let index_set: id = msg_send![class!(NSMutableIndexSet), new];
for index in indexes {
let _: () = msg_send![index_set, addIndex: index];
}
self.objc.with_mut(|obj| {
let _: () = msg_send![obj, selectRowIndexes:index_set byExtendingSelection:match extends_existing {
true => YES,
false => NO
}];
});
}
}
/// This hack exists to avoid a bug with how Rust's model isn't really friendly with more
/// old-school GUI models. The tl;dr is that we unfortunately have to cheat a bit to gracefully
/// handle two conditions.
///
/// The gist of it is that there are two situations (`perform_batch_updates` and `insert_rows`)
/// where we call over to the list view to, well, perform updates. This causes the internal
/// machinery of AppKit to call to the delegate, and the delegate then - rightfully - calls to
/// dequeue a cell.
///
/// The problem is then that dequeue'ing a cell requires borrowing the underlying cell handler,
/// per Rust's model. We haven't been able to drop our existing lock though! Thus it winds up
/// panic'ing and all hell breaks loose.
///
/// For now, we just drop to Objective-C and message pass directly to avoid a
/// double-locking-attempt on the Rust side of things. This is explicitly not ideal, and if
/// you're reading this and rightfully going "WTF?", I encourage you to contribute a solution
/// if you can come up with one.
///
/// In practice, this hack isn't that bad - at least, no worse than existing Objective-C code.
/// The behavior is relatively well understood and documented in the above paragraph, so I'm
/// comfortable with the hack for now.
///
/// To be ultra-clear: the hack is that we don't `borrow_mut` before sending a message. It just
/// feels dirty, hence the novel. ;P
fn hack_avoid_dequeue_loop<F: Fn(&Object)>(&self, handler: F) {
self.objc.get(handler);
}
/// This method should be used when inserting or removing multiple rows at once. Under the
/// hood, it batches the changes and tries to ensure things are done properly. The provided
/// `ListView` for the handler is your `ListView`, and you can call `insert_rows`,
/// `reload_rows`, or `remove_rows` from there.
///
/// ```rust,no_run
/// use cacao::listview::ListView;
/// use cacao::listview::RowAnimation;
/// let list_view: ListView<()> = todo!();
/// list_view.perform_batch_updates(|listview| {
/// listview.insert_rows(&[0, 2], RowAnimation::SlideDown);
/// });
/// ```
pub fn perform_batch_updates<F: Fn(ListView)>(&self, update: F) {
// Note that we need to thread the `with_mut` calls carefully, to avoid deadlocking.
#[cfg(feature = "appkit")]
{
self.objc.get(|obj| unsafe {
let _: () = msg_send![obj, beginUpdates];
});
let handle = self.clone_as_handle();
update(handle);
// This is done for a very explicit reason; see the comments on the method itself for
// an explanation.
self.hack_avoid_dequeue_loop(|obj| unsafe {
let _: () = msg_send![obj, endUpdates];
});
}
}
/// Insert new rows at the specified indexes, with the specified animation.
///
/// Your underlying data store must be updated *before* calling this. If inserting multiple
/// rows at once, you should also run this inside a `perform_batch_updates` call, as that will
/// optimize things accordingly.
pub fn insert_rows(&self, indexes: &[usize], animation: RowAnimation) {
#[cfg(feature = "appkit")]
unsafe {
let index_set: id = msg_send![class!(NSMutableIndexSet), new];
for index in indexes {
let x: NSUInteger = *index as NSUInteger;
let _: () = msg_send![index_set, addIndex: x];
}
let animation_options: NSUInteger = animation.into();
// We need to temporarily retain this; it can drop after the underlying NSTableView
// has also retained it.
let x = ShareId::from_ptr(index_set);
// This is done for a very explicit reason; see the comments on the method itself for
// an explanation.
self.hack_avoid_dequeue_loop(|obj| {
let _: () = msg_send![obj, insertRowsAtIndexes:&*x withAnimation:animation_options];
});
}
}
/// Reload the rows at the specified indexes.
pub fn reload_rows(&self, indexes: &[usize]) {
#[cfg(feature = "appkit")]
unsafe {
let index_set: id = msg_send![class!(NSMutableIndexSet), new];
for index in indexes {
let x: NSUInteger = *index as NSUInteger;
let _: () = msg_send![index_set, addIndex: x];
}
let x = ShareId::from_ptr(index_set);
let ye: id = msg_send![class!(NSIndexSet), indexSetWithIndex:0];
let y = ShareId::from_ptr(ye);
// Must use `get` to avoid a double lock.
self.objc.get(|obj| {
let _: () = msg_send![obj, reloadDataForRowIndexes:&*x columnIndexes:&*y];
});
}
}
/// Remove rows at the specified indexes, with the specified animation.
///
/// Your underlying data store must be updated *before* calling this. If removing multiple
/// rows at once, you should also run this inside a `perform_batch_updates` call, as that will
/// optimize things accordingly.
pub fn remove_rows(&self, indexes: &[usize], animations: RowAnimation) {
#[cfg(feature = "appkit")]
unsafe {
let index_set: id = msg_send![class!(NSMutableIndexSet), new];
for index in indexes {
let x: NSUInteger = *index as NSUInteger;
let _: () = msg_send![index_set, addIndex: x];
}
let animation_options: NSUInteger = animations.into();
// We need to temporarily retain this; it can drop after the underlying NSTableView
// has also retained it.
let x = ShareId::from_ptr(index_set);
self.objc.with_mut(|obj| {
let _: () = msg_send![obj, removeRowsAtIndexes:&*x withAnimation:animation_options];
});
}
}
/// Sets an enforced row-height; if you need dynamic rows, you'll want to
/// look at ListViewDelegate methods, or use AutoLayout.
pub fn set_row_height(&self, height: CGFloat) {
self.objc.with_mut(|obj| unsafe {
let _: () = msg_send![obj, setRowHeight: height];
});
}
/// This defaults to true. If you're using manual heights, you may want to set this to `false`,
/// as it will tell AppKit internally to just use the number instead of trying to judge
/// heights.
///
/// It can make some scrolling situations much smoother.
pub fn set_uses_automatic_row_heights(&self, uses: bool) {
#[cfg(feature = "appkit")]
self.objc.with_mut(|obj| unsafe {
let _: () = msg_send![obj, setUsesAutomaticRowHeights:match uses {
true => YES,
false => NO
}];
});
}
/// In AppKit, this will instruct the underlying NSTableView to alternate
/// background colors automatically. If you set this, you possibly want
/// to hard-set a row height as well.
pub fn set_uses_alternating_backgrounds(&self, uses: bool) {
#[cfg(feature = "appkit")]
self.objc.with_mut(|obj| unsafe {
let _: () = msg_send![obj, setUsesAlternatingRowBackgroundColors:match uses {
true => YES,
false => NO
}];
});
}
/// End actions for a row. API subject to change.
pub fn set_row_actions_visible(&self, visible: bool) {
#[cfg(feature = "appkit")]
self.objc.with_mut(|obj| unsafe {
let _: () = msg_send![obj, setRowActionsVisible:match visible {
true => YES,
false => NO
}];
});
}
/// Makes this table view the first responder.
#[cfg(feature = "appkit")]
pub fn make_first_responder(&self) {
self.objc.with_mut(|obj| unsafe {
let window: id = msg_send![&*obj, window];
let _: () = msg_send![window, makeFirstResponder:&*obj];
});
}
/// Reloads the underlying ListView. This is more expensive than handling insert/reload/remove
/// calls yourself, but often easier to implement.
///
/// Calling this will reload (and redraw) your listview based on whatever the data source
/// reports back.
pub fn reload(&self) {
self.objc.with_mut(|obj| unsafe {
let _: () = msg_send![obj, reloadData];
});
}
/// Returns the selected row.
pub fn get_selected_row_index(&self) -> NSInteger {
self.objc.get(|obj| unsafe { msg_send![obj, selectedRow] })
}
/// Returns the currently clicked row. This is AppKit-specific, and is generally used in context
/// menu generation to determine what item the context menu should be for. If the clicked area
/// is not an actual row, this will return `-1`.
///
/// For example (minus the other necessary ListViewDelegate pieces):
///
/// ```rust,no_run
/// use cacao::appkit::menu::MenuItem;
/// use cacao::listview::{ListViewDelegate, ListView, ListViewRow};
/// struct MyListView {
/// list_view: ListView<()>,
/// };
/// impl ListViewDelegate for MyListView {
/// const NAME: &'static str = "RootListView";
/// fn context_menu(&self) -> Vec<MenuItem> {
/// let clicked_row = self.list_view.get_clicked_row_index();
///
/// // You could treat this as a "new" menu.
/// if clicked_row == -1 {
/// return vec![];
/// }
///
/// // User right-clicked on a row, so let's show an edit menu.
/// vec![MenuItem::new("Edit")]
/// }
/// fn did_load(&mut self, _: ListView) { todo!() }
/// fn number_of_items(&self) -> usize { todo!() }
/// fn item_for(&self, _: usize) -> ListViewRow { todo!() }
/// }
/// ```
pub fn get_clicked_row_index(&self) -> NSInteger {
self.objc.get(|obj| unsafe { msg_send![obj, clickedRow] })
}
}
impl<T> ObjcAccess for ListView<T> {
fn with_backing_obj_mut<F: Fn(id)>(&self, handler: F) {
// In AppKit, we need to provide the scrollview for layout purposes - iOS and tvOS will know
// what to do normally.
#[cfg(feature = "appkit")]
self.scrollview.objc.with_mut(handler);
}
fn get_from_backing_obj<F: Fn(&Object) -> R, R>(&self, handler: F) -> R {
// In AppKit, we need to provide the scrollview for layout purposes - iOS and tvOS will know
// what to do normally.
//
// @TODO: Review this, as property access isn't really used in the same place as layout
// stuff... hmm...
#[cfg(feature = "appkit")]
self.scrollview.objc.get(handler)
}
}
impl<T> Layout for ListView<T> {}
impl<T> Drop for ListView<T> {
/// A bit of extra cleanup for delegate callback pointers. If the originating `View` is being
/// dropped, we do some logic to clean it all up (e.g, we go ahead and check to see if
/// this has a superview (i.e, it's in the heirarchy) on the AppKit side. If it does, we go
/// ahead and remove it - this is intended to match the semantics of how Rust handles things).
///
/// There are, thankfully, no delegates we need to break here.
fn drop(&mut self) {
/*if self.delegate.is_some() {
unsafe {
let superview: id = msg_send![&*self.objc, superview];
if superview != nil {
let _: () = msg_send![&*self.objc, removeFromSuperview];
}
}
}*/
}
}