Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove outdated documentation in LifeCycle events #2320

Merged
merged 1 commit into from
Jan 2, 2023
Merged

Remove outdated documentation in LifeCycle events #2320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ You can find its changes [documented below](#070---2021-01-01).
- Fix `Controller` links for `Click` ([#2158] by [@yrns])
- Delete inaccurate line for `KeyEvent` ([#2247] by [@amtep])
- Added examples in `TextBox` ([#2284] by [@ThomasMcandrew])
- Removed outdated section in docs for `LifeCycle::WidgetAdded` ([#2320] by [@sprocklem])

### Examples
- Add readme ([#1423] by [@JAicewizard])
Expand Down Expand Up @@ -570,6 +571,7 @@ Last release without a changelog :(
[@barsae]: https://github.com/barsae
[@amtep]: https://github.com/amtep
[@ThomasMcandrew]: https:github.com/ThomasMcandrew
[@sprocklem]: https://github.com/sprocklem

[#599]: https://github.com/linebender/druid/pull/599
[#611]: https://github.com/linebender/druid/pull/611
Expand Down Expand Up @@ -871,6 +873,7 @@ Last release without a changelog :(
[#2247]: https://github.com/linebender/druid/pull/2247
[#2274]: https://github.com/linebender/druid/pull/2274
[#2284]: https://github.com/linebender/druid/pull/2284
[#2320]: https://github.com/linebender/druid/pull/2320

[Unreleased]: https://github.com/linebender/druid/compare/v0.7.0...master
[0.7.0]: https://github.com/linebender/druid/compare/v0.6.0...v0.7.0
Expand Down
9 changes: 1 addition & 8 deletions druid/src/event.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,14 +249,7 @@ pub enum LifeCycle {
/// itself will handle registering those children with the system; this is
/// required for things like correct routing of events.
///
/// ## Participating in focus
///
/// Widgets which wish to participate in automatic focus (using tab to change
/// focus) must handle this event and call [`LifeCycleCtx::register_for_focus`].
///
/// [`LifeCycleCtx::register_child`]: struct.LifeCycleCtx.html#method.register_child
/// [`WidgetPod`]: struct.WidgetPod.html
/// [`LifeCycleCtx::register_for_focus`]: struct.LifeCycleCtx.html#method.register_for_focus
WidgetAdded,
/// Called when the [`Size`] of the widget changes.
///
Expand Down Expand Up @@ -287,7 +280,7 @@ pub enum LifeCycle {
/// This is called when the widget-tree changes and druid wants to rebuild the
/// Focus-chain.
///
/// It is the only place from witch [`register_for_focus`] should be called.
/// It is the only place from which [`register_for_focus`] should be called.
/// By doing so the widget can get focused by other widgets using [`focus_next`] or [`focus_prev`].
///
/// [`register_for_focus`]: crate::LifeCycleCtx::register_for_focus
Expand Down