elias/imgui-rs
1
0
Fork 0
mirror of https://github.com/eliasstepanik/imgui-rs.git synced 2026-01-15 07:28:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

fixed up deadlinks

Browse Source
This commit is contained in:
Jack Mac 2021-09-12 19:04:26 -04:00
parent ee1d921799
commit 611f46a71d
2 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
imgui/src/widget/combo_box.rs
View File

@ -169,13 +169,13 @@ create_token!(
impl<'ui> Ui<'ui> {
/// Creates a combo box which can be appended to with `Selectable::new`.
///
/// If you do not want to provide a preview, use [begin_combo_no_preview]. If you want
/// to pass flags, use [begin_combo_with_flags].
///
/// Returns `Some(ComboBoxToken)` if the combo box is open. After content has been
/// rendered, the token must be ended by calling `.end()`.
/// If you do not want to provide a preview, use [`begin_combo_no_preview`]. If you want
/// to pass flags, use [`begin_combo_with_flags`].
///
/// Returns `None` if the combo box is not open and no content should be rendered.
///
/// [`begin_combo_no_preview`]: Ui::begin_combo_no_preview
/// [`begin_combo_with_flags`]: Ui::begin_combo_with_flags
#[must_use]
#[doc(alias = "BeginCombo")]
pub fn begin_combo(
@ -193,6 +193,8 @@ impl<'ui> Ui<'ui> {
/// rendered, the token must be ended by calling `.end()`.
///
/// Returns `None` if the combo box is not open and no content should be rendered.
///
/// [begin_combo_no_preview]: Ui::begin_combo_no_preview
#[must_use]
#[doc(alias = "BeginCombo")]
pub fn begin_combo_with_flags(
@ -213,6 +215,9 @@ impl<'ui> Ui<'ui> {
/// rendered, the token must be ended by calling `.end()`.
///
/// Returns `None` if the combo box is not open and no content should be rendered.
///
/// [begin_combo]: Ui::begin_combo
/// [begin_combo_no_preview_with_flags]: Ui::begin_combo_no_preview_with_flags
#[must_use]
#[doc(alias = "BeginCombo")]
pub fn begin_combo_no_preview(&self, label: impl AsRef<str>) -> Option<ComboBoxToken<'ui>> {
@ -226,6 +231,8 @@ impl<'ui> Ui<'ui> {
/// rendered, the token must be ended by calling `.end()`.
///
/// Returns `None` if the combo box is not open and no content should be rendered.
///
/// [begin_combo_no_preview]: Ui::begin_combo_no_preview
#[must_use]
#[doc(alias = "BeginCombo")]
pub fn begin_combo_no_preview_with_flags(

7
imgui/src/widget/tab.rs
View File

@ -169,7 +169,7 @@ create_token!(
impl Ui<'_> {
/// Creates a tab bar and returns a tab bar token, allowing you to append
/// Tab items afterwards. This passes no flags. To pass flags explicitly,
/// use [tab_bar_with_flags].
/// use [tab_bar_with_flags](Self::tab_bar_with_flags).
pub fn tab_bar(&self, id: impl AsRef<str>) -> Option<TabBarToken<'_>> {
self.tab_bar_with_flags(id, TabBarFlags::empty())
}
@ -195,7 +195,10 @@ impl Ui<'_> {
/// Creates a new tab item and returns a token if its contents are visible.
///
/// By default, this doesn't pass an opened bool nor any flags. See [tab_item_with_opened]
/// and `[tab_item_with_flags]` for more.
/// and [tab_item_with_flags] for more.
///
/// [tab_item_with_opened]: Self::tab_item_with_opened
/// [tab_item_with_flags]: Self::tab_item_with_flags
pub fn tab_item(&self, label: impl AsRef<str>) -> Option<TabItemToken<'_>> {
self.tab_item_with_flags(label, None, TabItemFlags::empty())
}