djkato/egui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve panel docs

Browse source 
Related to https://github.com/emilk/egui/issues/421
This commit is contained in:
Emil Ernerfeldt 2021-05-20 19:48:34 +02:00
parent de02f7d042
commit 5bc53ce069
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
egui/src/containers/panel.rs
View file

@ -1,6 +1,11 @@
//! Panels are fixed `Ui` regions. //! Panels are fixed [`Ui`] regions.
//! Together with `Window` and `Area`:s they are //!
//! Together with [`Window`] and [`Area`]:s they are
//! the only places where you can put you widgets. //! the only places where you can put you widgets.
//!
//! The order in which you add panels matter!
//!
//! Add [`CentralPanel`] and [`Window`]:s last.
use crate::*; use crate::*;
@ -8,7 +13,7 @@ use crate::*;
/// A panel that covers the entire left side of the screen. /// A panel that covers the entire left side of the screen.
/// ///
/// `SidePanel`s should be added before adding any [`Window`]s. /// `SidePanel`s must be added before adding any [`CentralPanel`] or [`Window`]s.
/// ///
/// ``` /// ```
/// # let mut ctx = egui::CtxRef::default(); /// # let mut ctx = egui::CtxRef::default();
@ -68,7 +73,7 @@ impl SidePanel {
/// A panel that covers the entire top side of the screen. /// A panel that covers the entire top side of the screen.
/// ///
/// `TopPanel`s should be added before adding any [`Window`]s. /// `TopPanel`s must be added before adding any [`CentralPanel`] or [`Window`]s.
/// ///
/// ``` /// ```
/// # let mut ctx = egui::CtxRef::default(); /// # let mut ctx = egui::CtxRef::default();
@ -131,7 +136,7 @@ impl TopPanel {
/// A panel that covers the remainder of the screen, /// A panel that covers the remainder of the screen,
/// i.e. whatever area is left after adding other panels. /// i.e. whatever area is left after adding other panels.
/// ///
/// `CentralPanel` should be added after all other panels. /// `CentralPanel` must be added after all other panels.
/// Any [`Window`]s and [`Area`]s will cover the `CentralPanel`. /// Any [`Window`]s and [`Area`]s will cover the `CentralPanel`.
/// ///
/// ``` /// ```