HNDivider Class Reference

Non-interactive separator created by a client. More...

#include "HNDivider.h"

Inheritance diagram for HNDivider:

Collaboration diagram for HNDivider:

Static Public Member Functions
static std::shared_ptr< HNDivider >	Make (const std::string &title="", HNObject *parent=nullptr) noexcept
	Creates a new divider.

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 unique identifier of this object within the client.
Type	type () const noexcept
	Returns the immutable role/type of this object.
std::shared_ptr< HNClient >	client () const noexcept
	Returns the client that owns this object.
	~HNObject () noexcept
	Destructor. Notifies the bar that the object was destroyed.
Public Member Functions inherited from HNWithTitle
const std::string &	title () const noexcept
	Returns the current title.
void	setTitle (const std::string &title) noexcept
	Updates the title and notifies the bar.
virtual	~HNWithTitle () noexcept=default
	Virtual destructor (makes the mixin polymorphic for safe cross-casts).
Public Member Functions inherited from HNWithParent
virtual	~HNWithParent () noexcept
	Destructor. Detaches this object from its parent.
HNObject *	parent () const noexcept
	Returns the parent object.
bool	setParent (HNObject *parent) noexcept
	Sets the parent.
bool	insertBefore (HNObject *sibling) noexcept
	Inserts this object before the specified sibling.
Data Fields inherited from HNObject
CZSignal< HNObject * >	onClicked
	Emitted when the bar notifies that this object was clicked.
Protected Member Functions inherited from HNObject
	HNObject (std::shared_ptr< HNClient > client, UInt32 id, Type type) noexcept
	Constructs an object owned by the given client.

Detailed Description

Non-interactive separator created by a client.

A divider can optionally carry a title, which the bar may render as a section label.

Member Function Documentation

Make()

static std::shared_ptr< HNDivider > Make ( const std::string &  title = "", HNObject *  parent = nullptr  )

staticnoexcept

Creates a new divider.

Parameters

title	Optional section title.
parent	Object to attach this divider to, or nullptr.

Returns

Shared pointer to the new divider, or nullptr on failure.

---

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

• /home/runner/work/Heaven/Heaven/src/CZ/Heaven/Client/HNDivider.h