opynsim
Unofficial C++ Documentation
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
osc::Popup Class Referenceabstract

#include <popup.h>

Inheritance diagram for osc::Popup:
[legend]
Collaboration diagram for osc::Popup:
[legend]

Public Member Functions

 Popup (Widget *parent, std::string_view name, Vector2 dimensions={512.0f, 0.0f}, ui::PanelFlags=ui::PanelFlag::AlwaysAutoResize)
 
bool is_open ()
 
void open ()
 
void close ()
 
bool begin_popup ()
 
void end_popup ()
 
- Public Member Functions inherited from osc::Widget
 Widget (Widget *parent=nullptr)
 
virtual ~Widget () noexcept
 
bool on_event (Event &e)
 
void on_mount ()
 
void on_unmount ()
 
void on_tick ()
 
void on_draw ()
 
LifetimedPtr< Widgetweak_ref ()
 
Widgetparent ()
 
template<std::derived_from< Widget > T>
Tfirst_ancestor_of_type ()
 
const Widgetparent () const
 
void set_parent (Widget *)
 
void set_parent (Widget &widget)
 
CStringView name () const
 
void set_name (std::string_view)
 

Protected Member Functions

 Popup (std::unique_ptr< PopupPrivate > &&)
 
bool is_popup_opened_this_frame () const
 
void request_close ()
 
bool is_modal () const
 
void set_modal (bool)
 
void set_rect (const Rect &)
 
void set_dimensions (Vector2)
 
void set_position (std::optional< Vector2 >)
 
 OSC_WIDGET_DATA_GETTERS (PopupPrivate)
 
- Protected Member Functions inherited from osc::Widget
 Widget (std::unique_ptr< WidgetPrivate > &&)
 
const WidgetPrivatebase_private_data () const
 
WidgetPrivatebase_private_data ()
 
virtual bool impl_on_event (Event &)
 
virtual bool impl_on_display_state_change_event (DisplayStateChangeEvent &)
 
virtual bool impl_on_drop_file_event (DropFileEvent &)
 
virtual bool impl_on_key_event (KeyEvent &)
 
virtual bool impl_on_mouse_event (MouseEvent &)
 
virtual bool impl_on_mouse_wheel_event (MouseWheelEvent &)
 
virtual bool impl_on_quit_event (QuitEvent &)
 
virtual bool impl_on_text_input_event (TextInputEvent &)
 
virtual bool impl_on_window_event (WindowEvent &)
 
virtual void impl_on_mount ()
 
virtual void impl_on_unmount ()
 
virtual void impl_on_tick ()
 

Private Member Functions

void impl_on_draw () override
 
virtual void impl_before_imgui_begin_popup ()
 
virtual void impl_after_imgui_begin_popup ()
 
virtual void impl_draw_content ()=0
 
virtual void impl_on_close ()
 

Constructor & Destructor Documentation

◆ Popup() [1/2]

osc::Popup::Popup ( Widget parent,
std::string_view  name,
Vector2  dimensions = {512.0f, 0.0f},
ui::PanelFlags  = ui::PanelFlag::AlwaysAutoResize 
)
explicit

◆ Popup() [2/2]

osc::Popup::Popup ( std::unique_ptr< PopupPrivate > &&  )
explicitprotected

Member Function Documentation

◆ begin_popup()

bool osc::Popup::begin_popup ( )

◆ close()

void osc::Popup::close ( )

◆ end_popup()

void osc::Popup::end_popup ( )

◆ impl_after_imgui_begin_popup()

virtual void osc::Popup::impl_after_imgui_begin_popup ( )
inlineprivatevirtual

◆ impl_before_imgui_begin_popup()

virtual void osc::Popup::impl_before_imgui_begin_popup ( )
inlineprivatevirtual

◆ impl_draw_content()

virtual void osc::Popup::impl_draw_content ( )
privatepure virtual

Implemented in osc::SaveChangesPopup.

◆ impl_on_close()

virtual void osc::Popup::impl_on_close ( )
inlineprivatevirtual

◆ impl_on_draw()

void osc::Popup::impl_on_draw ( )
overrideprivatevirtual

Reimplemented from osc::Widget.

◆ is_modal()

bool osc::Popup::is_modal ( ) const
protected

◆ is_open()

bool osc::Popup::is_open ( )

◆ is_popup_opened_this_frame()

bool osc::Popup::is_popup_opened_this_frame ( ) const
protected

◆ open()

void osc::Popup::open ( )

◆ OSC_WIDGET_DATA_GETTERS()

osc::Popup::OSC_WIDGET_DATA_GETTERS ( PopupPrivate  )
protected

◆ request_close()

void osc::Popup::request_close ( )
protected

◆ set_dimensions()

void osc::Popup::set_dimensions ( Vector2  )
protected

◆ set_modal()

void osc::Popup::set_modal ( bool  )
protected

◆ set_position()

void osc::Popup::set_position ( std::optional< Vector2 )
protected

◆ set_rect()

void osc::Popup::set_rect ( const Rect )
protected

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