toolbar.rs

  1use crate::ItemHandle;
  2use gpui::{
  3    AnyView, Entity, EntityId, EventEmitter, ParentElement as _, Render, Styled, View, ViewContext,
  4    WindowContext,
  5};
  6use ui::prelude::*;
  7use ui::{h_stack, v_stack};
  8
  9pub enum ToolbarItemEvent {
 10    ChangeLocation(ToolbarItemLocation),
 11}
 12
 13pub trait ToolbarItemView: Render + EventEmitter<ToolbarItemEvent> {
 14    fn set_active_pane_item(
 15        &mut self,
 16        active_pane_item: Option<&dyn crate::ItemHandle>,
 17        cx: &mut ViewContext<Self>,
 18    ) -> ToolbarItemLocation;
 19
 20    fn pane_focus_update(&mut self, _pane_focused: bool, _cx: &mut ViewContext<Self>) {}
 21
 22    /// Number of times toolbar's height will be repeated to get the effective height.
 23    /// Useful when multiple rows one under each other are needed.
 24    /// The rows have the same width and act as a whole when reacting to resizes and similar events.
 25    fn row_count(&self, _cx: &WindowContext) -> usize {
 26        1
 27    }
 28}
 29
 30trait ToolbarItemViewHandle: Send {
 31    fn id(&self) -> EntityId;
 32    fn to_any(&self) -> AnyView;
 33    fn set_active_pane_item(
 34        &self,
 35        active_pane_item: Option<&dyn ItemHandle>,
 36        cx: &mut WindowContext,
 37    ) -> ToolbarItemLocation;
 38    fn focus_changed(&mut self, pane_focused: bool, cx: &mut WindowContext);
 39    fn row_count(&self, cx: &WindowContext) -> usize;
 40}
 41
 42#[derive(Copy, Clone, Debug, PartialEq)]
 43pub enum ToolbarItemLocation {
 44    Hidden,
 45    PrimaryLeft,
 46    PrimaryRight,
 47    Secondary,
 48}
 49
 50pub struct Toolbar {
 51    active_item: Option<Box<dyn ItemHandle>>,
 52    hidden: bool,
 53    can_navigate: bool,
 54    items: Vec<(Box<dyn ToolbarItemViewHandle>, ToolbarItemLocation)>,
 55}
 56
 57impl Toolbar {
 58    fn has_any_visible_items(&self) -> bool {
 59        self.items
 60            .iter()
 61            .any(|(_item, location)| *location != ToolbarItemLocation::Hidden)
 62    }
 63
 64    fn left_items(&self) -> impl Iterator<Item = &dyn ToolbarItemViewHandle> {
 65        self.items.iter().filter_map(|(item, location)| {
 66            if *location == ToolbarItemLocation::PrimaryLeft {
 67                Some(item.as_ref())
 68            } else {
 69                None
 70            }
 71        })
 72    }
 73
 74    fn right_items(&self) -> impl Iterator<Item = &dyn ToolbarItemViewHandle> {
 75        self.items.iter().filter_map(|(item, location)| {
 76            if *location == ToolbarItemLocation::PrimaryRight {
 77                Some(item.as_ref())
 78            } else {
 79                None
 80            }
 81        })
 82    }
 83
 84    fn secondary_items(&self) -> impl Iterator<Item = &dyn ToolbarItemViewHandle> {
 85        self.items.iter().filter_map(|(item, location)| {
 86            if *location == ToolbarItemLocation::Secondary {
 87                Some(item.as_ref())
 88            } else {
 89                None
 90            }
 91        })
 92    }
 93}
 94
 95impl Render for Toolbar {
 96    fn render(&mut self, cx: &mut ViewContext<Self>) -> impl IntoElement {
 97        if !self.has_any_visible_items() {
 98            return div();
 99        }
100
101        let secondary_item = self.secondary_items().next().map(|item| item.to_any());
102
103        let has_left_items = self.left_items().count() > 0;
104        let has_right_items = self.right_items().count() > 0;
105
106        v_stack()
107            .p_2()
108            .when(has_left_items || has_right_items, |this| this.gap_2())
109            .border_b()
110            .border_color(cx.theme().colors().border_variant)
111            .bg(cx.theme().colors().toolbar_background)
112            .child(
113                h_stack()
114                    .justify_between()
115                    .when(has_left_items, |this| {
116                        this.child(
117                            h_stack()
118                                .flex_1()
119                                .justify_start()
120                                .children(self.left_items().map(|item| item.to_any())),
121                        )
122                    })
123                    .when(has_right_items, |this| {
124                        this.child(
125                            h_stack()
126                                .flex_1()
127                                .justify_end()
128                                .children(self.right_items().map(|item| item.to_any())),
129                        )
130                    }),
131            )
132            .children(secondary_item)
133    }
134}
135
136// todo!()
137// impl View for Toolbar {
138//     fn ui_name() -> &'static str {
139//         "Toolbar"
140//     }
141
142//     fn render(&mut self, cx: &mut ViewContext<Self>) -> AnyElement<Self> {
143//         let theme = &theme::current(cx).workspace.toolbar;
144
145//         let mut primary_left_items = Vec::new();
146//         let mut primary_right_items = Vec::new();
147//         let mut secondary_item = None;
148//         let spacing = theme.item_spacing;
149//         let mut primary_items_row_count = 1;
150
151//         for (item, position) in &self.items {
152//             match *position {
153//                 ToolbarItemLocation::Hidden => {}
154
155//                 ToolbarItemLocation::PrimaryLeft { flex } => {
156//                     primary_items_row_count = primary_items_row_count.max(item.row_count(cx));
157//                     let left_item = ChildView::new(item.as_any(), cx).aligned();
158//                     if let Some((flex, expanded)) = flex {
159//                         primary_left_items.push(left_item.flex(flex, expanded).into_any());
160//                     } else {
161//                         primary_left_items.push(left_item.into_any());
162//                     }
163//                 }
164
165//                 ToolbarItemLocation::PrimaryRight { flex } => {
166//                     primary_items_row_count = primary_items_row_count.max(item.row_count(cx));
167//                     let right_item = ChildView::new(item.as_any(), cx).aligned().flex_float();
168//                     if let Some((flex, expanded)) = flex {
169//                         primary_right_items.push(right_item.flex(flex, expanded).into_any());
170//                     } else {
171//                         primary_right_items.push(right_item.into_any());
172//                     }
173//                 }
174
175//                 ToolbarItemLocation::Secondary => {
176//                     secondary_item = Some(
177//                         ChildView::new(item.as_any(), cx)
178//                             .constrained()
179//                             .with_height(theme.height * item.row_count(cx) as f32)
180//                             .into_any(),
181//                     );
182//                 }
183//             }
184//         }
185
186//         let container_style = theme.container;
187//         let height = theme.height * primary_items_row_count as f32;
188
189//         let mut primary_items = Flex::row().with_spacing(spacing);
190//         primary_items.extend(primary_left_items);
191//         primary_items.extend(primary_right_items);
192
193//         let mut toolbar = Flex::column();
194//         if !primary_items.is_empty() {
195//             toolbar.add_child(primary_items.constrained().with_height(height));
196//         }
197//         if let Some(secondary_item) = secondary_item {
198//             toolbar.add_child(secondary_item);
199//         }
200
201//         if toolbar.is_empty() {
202//             toolbar.into_any_named("toolbar")
203//         } else {
204//             toolbar
205//                 .contained()
206//                 .with_style(container_style)
207//                 .into_any_named("toolbar")
208//         }
209//     }
210// }
211
212impl Toolbar {
213    pub fn new() -> Self {
214        Self {
215            active_item: None,
216            items: Default::default(),
217            hidden: false,
218            can_navigate: true,
219        }
220    }
221
222    pub fn set_can_navigate(&mut self, can_navigate: bool, cx: &mut ViewContext<Self>) {
223        self.can_navigate = can_navigate;
224        cx.notify();
225    }
226
227    pub fn add_item<T>(&mut self, item: View<T>, cx: &mut ViewContext<Self>)
228    where
229        T: 'static + ToolbarItemView,
230    {
231        let location = item.set_active_pane_item(self.active_item.as_deref(), cx);
232        cx.subscribe(&item, |this, item, event, cx| {
233            if let Some((_, current_location)) =
234                this.items.iter_mut().find(|(i, _)| i.id() == item.id())
235            {
236                match event {
237                    ToolbarItemEvent::ChangeLocation(new_location) => {
238                        if new_location != current_location {
239                            *current_location = *new_location;
240                            cx.notify();
241                        }
242                    }
243                }
244            }
245        })
246        .detach();
247        self.items.push((Box::new(item), location));
248        cx.notify();
249    }
250
251    pub fn set_active_item(&mut self, item: Option<&dyn ItemHandle>, cx: &mut ViewContext<Self>) {
252        self.active_item = item.map(|item| item.boxed_clone());
253        self.hidden = self
254            .active_item
255            .as_ref()
256            .map(|item| !item.show_toolbar(cx))
257            .unwrap_or(false);
258
259        for (toolbar_item, current_location) in self.items.iter_mut() {
260            let new_location = toolbar_item.set_active_pane_item(item, cx);
261            if new_location != *current_location {
262                *current_location = new_location;
263                cx.notify();
264            }
265        }
266    }
267
268    pub fn focus_changed(&mut self, focused: bool, cx: &mut ViewContext<Self>) {
269        for (toolbar_item, _) in self.items.iter_mut() {
270            toolbar_item.focus_changed(focused, cx);
271        }
272    }
273
274    pub fn item_of_type<T: ToolbarItemView>(&self) -> Option<View<T>> {
275        self.items
276            .iter()
277            .find_map(|(item, _)| item.to_any().downcast().ok())
278    }
279
280    pub fn hidden(&self) -> bool {
281        self.hidden
282    }
283}
284
285impl<T: ToolbarItemView> ToolbarItemViewHandle for View<T> {
286    fn id(&self) -> EntityId {
287        self.entity_id()
288    }
289
290    fn to_any(&self) -> AnyView {
291        self.clone().into()
292    }
293
294    fn set_active_pane_item(
295        &self,
296        active_pane_item: Option<&dyn ItemHandle>,
297        cx: &mut WindowContext,
298    ) -> ToolbarItemLocation {
299        self.update(cx, |this, cx| {
300            this.set_active_pane_item(active_pane_item, cx)
301        })
302    }
303
304    fn focus_changed(&mut self, pane_focused: bool, cx: &mut WindowContext) {
305        self.update(cx, |this, cx| {
306            this.pane_focus_update(pane_focused, cx);
307            cx.notify();
308        });
309    }
310
311    fn row_count(&self, cx: &WindowContext) -> usize {
312        self.read(cx).row_count(cx)
313    }
314}
315
316// todo!()
317// impl From<&dyn ToolbarItemViewHandle> for AnyViewHandle {
318//     fn from(val: &dyn ToolbarItemViewHandle) -> Self {
319//         val.as_any().clone()
320//     }
321// }