Heaven v0.1.0-1
C++ global-menu library for Wayland sessions
Loading...
Searching...
No Matches
HNAction Class Reference

Clickable action item displayed in the bar. More...

#include "HNAction.h"

Inheritance diagram for HNAction:
Inheritance graph
[legend]
Collaboration diagram for HNAction:
Collaboration graph
[legend]

Additional Inherited Members

- Public Types inherited from HNObject
enum  Type {
  Topbar ,
  Menu ,
  Action ,
  Toggle ,
  Divider
}
 Enumeration of the possible object roles. More...
 
- Public Member Functions inherited from HNObject
UInt32 id () const noexcept
 Returns the client-assigned unique identifier of this object.
 
Type type () const noexcept
 Returns the immutable role/type of this object.
 
HNClientclient () const noexcept
 Returns the client that owns this object.
 
void click () noexcept
 Notifies the owning client that this object was clicked.
 
- Public Member Functions inherited from HNWithTitle
const std::string & title () const noexcept
 Returns the current title of the object.
 
virtual ~HNWithTitle () noexcept=default
 Virtual destructor.
 
- Public Member Functions inherited from HNWithIcon
const std::string & icon () const noexcept
 Returns the current icon name of the object.
 
virtual ~HNWithIcon () noexcept=default
 Virtual destructor.
 
- Public Member Functions inherited from HNWithShortcut
const std::string & shortcut () const noexcept
 Returns the current keyboard shortcut of the object.
 
virtual ~HNWithShortcut () noexcept=default
 Virtual destructor.
 
- Public Member Functions inherited from HNWithParent
HNObjectparent () const noexcept
 Returns the current parent of this object.
 
virtual ~HNWithParent () noexcept=default
 Virtual destructor.
 
- Public Member Functions inherited from HNWithEnabled
bool enabled () const noexcept
 Returns whether the object is currently enabled.
 
virtual ~HNWithEnabled () noexcept=default
 Virtual destructor.
 
- Static Public Member Functions inherited from HNObject
static bool IsValidType (UInt32 type) noexcept
 Checks whether a numeric value is a valid object type.
 
- Protected Member Functions inherited from HNObject
 HNObject (UInt32 id, Type type) noexcept
 Constructs an object with the given id and role.
 

Detailed Description

Clickable action item displayed in the bar.

When activated (see HNObject::click()), the click is forwarded to the owning client. It exposes a title, icon, shortcut and enabled state.


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