rex::ui::IDialog Class Reference

#include <rex/ui/ui_system.h>

Inheritance diagram for rex::ui::IDialog:

Public Member Functions
virtual bool	Draw (ImGuiIO &io)=0
virtual void	OnClose ()=0
virtual bool	NeedsContinuousPaint () const =0
virtual bool	WantsExclusiveInput () const =0
virtual void	OnShow ()=0
virtual bool	OnToggle ()=0

Detailed Description

A window the UI system draws with ImGui. Add it with IUISystem::AddDialog. Every hook runs on the UI thread. Derive from DialogBase to take the defaults.

Member Function Documentation

Draw()

virtual bool rex::ui::IDialog::Draw ( ImGuiIO & io )

pure virtual

Parameters

io	The IO of the current ImGui context.

Returns

False to close the dialog. The system then calls OnClose once and removes the dialog.

NeedsContinuousPaint()

virtual bool rex::ui::IDialog::NeedsContinuousPaint ( ) const

pure virtual

Reports whether the dialog needs a repaint after every frame.

Returns

True when the dialog changes without outside events.

Implemented in rex::ui::DialogBase.

OnClose()

virtual void rex::ui::IDialog::OnClose ( )

pure virtual

Called once after Draw returned false, before the system removes the dialog.

Implemented in rex::ui::DialogBase.

OnToggle()

virtual bool rex::ui::IDialog::OnToggle ( )

pure virtual

Lets an overlay handle its toggle bind while hidden.

Returns

True when the dialog handled the toggle and stays hidden.

Implemented in rex::ui::DialogBase.

WantsExclusiveInput()

virtual bool rex::ui::IDialog::WantsExclusiveInput ( ) const

pure virtual

Reports whether the dialog takes all title input while it shows, the pads included.

Returns

True to block the title input.

Implemented in rex::ui::DialogBase.

---

The documentation for this class was generated from the following file:

• rex/ui/ui_system.h