Lysa UI  0.0
Lysa UI —UI components for the Lysa Engine
PopupMenu Class Reference

Detailed Description

A modal Window displaying a menu at an anchor.

+ Inheritance diagram for PopupMenu:

Public Typedefs

using BuildCallback = std::function< void (MenuBox &)>
 Populates the attached menu before its size and position are calculated. More...
 
using SelectCallback = std::function< void (int32)>
 Receives the selected item index (0-based, separators excluded). More...
 

Public Member Functions

 PopupMenu (const Rect &anchor, const BuildCallback &buildMenu=nullptr, const SelectCallback &onSelect=nullptr, const std::string &resource="")
 
const auto & getMenu () const
 
void onAttach () override
 
bool onMouseDown (const MouseButton button, float, float) override
 
bool onKeyDown (const Key key) override
 
- Public Member Functions inherited from Window
 Window (const Rect &rect)
 
 ~Window () override = default
 
bool isAttached () const
 
void setResizeableBorders (const uint32 borders)
 
auto getResizeableBorders () const
 
auto isModal () const
 
void setModal (bool modal)
 
Style & getStyle () const
 
void setStyle (const std::shared_ptr< Style > &style)
 
void inheritStyle (const Window &other)
 
Widget & getWidget () const
 
void setWidget (std::shared_ptr< Widget > child=nullptr, const std::string &resources="", float padding=0)
 
template<typename T , typename... Args>
std::shared_ptr< T > create (const std::string &resource, const Alignment alignment, Args &&...args)
 
template<typename T , typename... Args>
std::shared_ptr< T > create (const Alignment alignment, Args &&...args)
 
template<typename T >
std::shared_ptr< T > add (const std::shared_ptr< T > &child, const Alignment alignment, const std::string &resource="", const bool overlap=false) const
 
void remove (const std::shared_ptr< Widget > &child) const
 
void setFocusedWidget (const std::shared_ptr< Widget > &widget)
 
void clearFocusedWidget ()
 
const auto & getFocusedWidget () const
 
bool focusNextWidget ()
 
bool focusPreviousWidget ()
 
auto getWidth () const
 
auto getHeight () const
 
void setRect (const Rect &newRect)
 
void setWidth (float width)
 
void setHeight (float height)
 
void setPos (float x, float y)
 
void setPos (const float2 &pos)
 
float getX () const
 
float getY () const
 
void setX (float x)
 
void setY (float y)
 
const auto & getRect () const
 
float getAspectRatio () const
 
auto isVisible () const
 
void setVisible (bool isVisible)
 
void hide ()
 
void show ()
 
void setTransparency (float alpha)
 
virtual void onDetach ()
 
virtual void onShow ()
 
virtual void onHide ()
 
virtual void onResize ()
 
virtual void onMove ()
 
virtual bool onTextInput (const std::string &text)
 
virtual bool onKeyUp (Key key)
 
virtual bool onMouseUp (MouseButton button, float x, float y)
 
virtual bool onMouseMove (uint32 buttonsState, float x, float y)
 
virtual void onGotFocus ()
 
virtual void onLostFocus ()
 
void setMinimumSize (float width, float height)
 
void setMaximumSize (float width, float height)
 
auto getMinimumWidth () const
 
auto getMinimumHeight () const
 
auto getMaximumWidth () const
 
auto getMaximumHeight () const
 
std::shared_ptr< Font > getFont () const
 
void setFont (const std::shared_ptr< Font > &font)
 
float getFontScale () const
 
void setFontScale (float fontScale)
 
void refresh () const
 
void attach (WindowManager *windowManager)
 
void close ()
 
Vector2DRenderer & getRenderer () const
 
RenderingWindow & getRenderingWindow () const
 
WindowManager & getWindowManager () const
 
void subscribe (const event_type &type, unique_id id, EventHandlerCallback callback)
 
void subscribe (const event_type &type, EventHandlerCallback callback)
 
void subscribe (const event_type &type, SignalHandlerCallback callback)
 
void unsubscribe (unique_id id)
 

Additional Inherited Members

- Public Types inherited from Window
enum  ResizeableBorder {
  RESIZEABLE_NONE = 0b0000, RESIZEABLE_LEFT = 0b0001, RESIZEABLE_RIGHT = 0b0010, RESIZEABLE_TOP = 0b0100,
  RESIZEABLE_BOTTOM = 0b1000
}
 
- Static Public Attributes inherited from Window
static constexpr uint32 MODAL_LAYER {2}
 

Member Typedef Documentation

using BuildCallback = std::function<void(MenuBox &)>

Populates the attached menu before its size and position are calculated.

using SelectCallback = std::function<void(int32)>

Receives the selected item index (0-based, separators excluded).

Constructor & Destructor Documentation

PopupMenu ( const Rect &  anchor,
const BuildCallback &  buildMenu = nullptr,
const SelectCallback &  onSelect = nullptr,
const std::string &  resource = "" 
)

Creates a popup menu, hanging below anchor.x/anchor.y and flipping above when necessary.

Parameters
anchorAnchor rectangle
buildMenuAdds items and separators callback
onSelectCalled on selection
resourceOptional resource string for the MenuBox

Member Function Documentation

const auto& getMenu ( ) const
inline
void onAttach ( )
overridevirtual

Event called after the Window have been attached to a WindowManager

Reimplemented from lysa::ui::Window::onAttach()

bool onKeyDown ( const Key  key)
overridevirtual

Event called when a key was pressed.

Parameters
keyThe key pressed.
Returns
True if event was handled.

Reimplemented from lysa::ui::Window::onKeyDown()

bool onMouseDown ( const MouseButton  button,
float  x,
float  y 
)
overridevirtual

Event called when a mouse button was pressed inside the Window.

Parameters
buttonThe mouse button.
xMouse X coordinate.
yMouse Y coordinate.
Returns
True if event was handled.

Reimplemented from lysa::ui::Window::onMouseDown()