Update Ui Style accessor function doc

This commit is contained in:
Lukasz Wiklendt 2021-09-21 12:29:02 +09:30
parent 78e31f9584
commit a0a04cdb91

View File

@ -3,8 +3,8 @@ use bitflags::bitflags;
use crate::input::mouse::MouseButton; use crate::input::mouse::MouseButton;
use crate::style::{Style, StyleColor}; use crate::style::{Style, StyleColor};
use crate::Ui;
use crate::sys; use crate::sys;
use crate::Ui;
bitflags! { bitflags! {
/// Item hover check option flags /// Item hover check option flags
@ -174,12 +174,12 @@ impl<'ui> Ui<'ui> {
self.ctx.style()[style_color] self.ctx.style()[style_color]
} }
/// Returns a shared reference to the current [`Style`]. This function is tagged as `unsafe` /// Returns a shared reference to the current [`Style`]. This function is tagged as `unsafe`
/// because pushing via [`Ui::push_style_color`](crate::Ui::push_style_color) or /// because pushing via [`push_style_color`](crate::Ui::push_style_color) or
/// [`UI::push_style_var`](crate::Ui::push_style_var) or popping via /// [`push_style_var`](crate::Ui::push_style_var) or popping via
/// [`ColorStackToken::pop`](crate::ColorStackToken::pop) or /// [`ColorStackToken::pop`](crate::ColorStackToken::pop) or
/// [`StyleStackToken::pop`](crate::StyleStackToken::pop) will modify the values in the returned /// [`StyleStackToken::pop`](crate::StyleStackToken::pop) will modify the values in the returned
/// shared reference. Therefore, you should not retain this reference across calls to push and /// shared reference. Therefore, you should not retain this reference across calls to push and
/// pop. /// pop. The [`clone_style`](Ui::clone_style) version may instead be used to avoid `unsafe`.
#[doc(alias = "GetStyle")] #[doc(alias = "GetStyle")]
pub unsafe fn style(&self) -> &Style { pub unsafe fn style(&self) -> &Style {
self.ctx.style() self.ctx.style()