gumball_button.h

Go to the documentation of this file.

#ifndef GUM_BUTTON_H
#define GUM_BUTTON_H
 
// View this file's documentation online: https://libgumball.psyops.studio/gumball__button_8h.html
 
/*! \file
 *  \ref        GUM_Button "GUM_Button data structure and hierarchy graph"
 *  \ingroup    elements
 *
 *  GUM_Button is a basic button element that can be selected and pressed,
 *  firing a signal you can connect a callback to.
 *
 *  \todo
 *      - Add a way to override cursor movement to the desired GUM_Button pointer.
 *      - Button highlighting animations
 *      - Make variables private
 *      - Document signals.
 *
 *  \author 2025 Agustín Bellagamba
 *  \copyright MIT License
*/
 
#include "gumball_widget.h"
 
/*! \name  Type System
 *  \brief Type UUID and cast operators
 *  @{
*/
#define GUM_BUTTON_TYPE             (GBL_TYPEID     (GUM_Button))           //!< Returns the GUM_Button Type UUID
#define GUM_BUTTON(self)            (GBL_CAST       (GUM_Button, self))     //!< Casts an instance of a compatible element to a GUM_Button
#define GUM_BUTTON_CLASS(klass)     (GBL_CLASS_CAST (GUM_Button, klass))    //!< Casts an class of a compatible element to a GUM_ButtonClass
#define GUM_BUTTON_CLASSOF(self)    (GBL_CLASSOF    (GUM_Button, self))     //!< Casts an instance of a compatible element to a GUM_ButtonClass
//! @}
 
#define GBL_SELF_TYPE                GUM_Button
 
GBL_DECLS_BEGIN
GBL_FORWARD_DECLARE_STRUCT(GUM_Button);
 
/*!
 *  \struct  GUM_ButtonClass
 *  \extends GUM_WidgetClass
 *  \brief   GUM_Button structure
 *
 *  GUM_ButtonClass derives from GUM_WidgetClass,
 *  adding nothing new.
*/
GBL_CLASS_DERIVE_EMPTY(GUM_Button, GUM_Widget)
 
/*!
 *  \class   GUM_Button
 *  \extends GUM_Widget
 *  \brief   Basic button element
 *
*/
 
/*!
 *  \name  Properties
 *  \brief Button properties you can set/get at or after creation.
 *  \note  You can also set/get properties from parent classes (see \ref GUM_Button).
 *  @{
*/
GBL_INSTANCE_DERIVE(GUM_Button, GUM_Widget)
    bool            isActive;            //!< If this button can be pressed.                                                                Default value is true
    bool            isSelectable;        //!< If this button can be selected.                                                               Default value is true
    //! \cond
    bool            isSelected;          // If this button is currently selected
    //! \endcond
    bool            isSelectedByDefault; //!< If this button should be selected by default when the cursor doesn't have a button selected.  Default value is false
GBL_INSTANCE_END
//! @}
 
GBL_PROPERTIES(GUM_Button,
    (isActive,              GBL_GENERIC, (READ, WRITE), GBL_BOOL_TYPE),
    (isSelectable,          GBL_GENERIC, (READ, WRITE), GBL_BOOL_TYPE),
    (isSelectedByDefault,   GBL_GENERIC, (READ, WRITE), GBL_BOOL_TYPE)
)
 
//! \cond
GBL_SIGNALS(GUM_Button,
    (onPressPrimary, (GBL_INSTANCE_TYPE, pReceiver)),  //!< \copydoc \ref gum_button_clicked
    (onPressSecondary, (GBL_INSTANCE_TYPE, pReceiver)), //!< For secondary actions (e.g., right-click)
    (onPressTertiary, (GBL_INSTANCE_TYPE, pReceiver))   //!< For tertiary actions (e.g., middle-click)
)
 
GblType GUM_Button_type(void);
//! \endcond
 
//! Returns a new GUM_Button. Optionally takes in a list of Name/Value pairs for properties
#define GUM_Button_create(/* propertyName, propertyValue */ ...) GBL_NEW(GUM_Button __VA_OPT__(,) __VA_ARGS__)
 
GBL_DECLS_END
 
#undef GBL_SELF_TYPE
 
#endif // GUM_BUTTON_H