Molybden API
Loading...
Searching...
No Matches
molybden::Dock Class Referenceabstract

Allows controlling application icon in the Dock on macOS. More...

#include <dock.hpp>

Public Member Functions

virtual std::shared_ptr< Appapp ()=0
 Returns the application instance for this Dock controller.
 
virtual void hide ()=0
 Hides the application icon in the Dock.
 
virtual void show ()=0
 Shows the application icon in the Dock.
 
virtual bool isVisible ()=0
 Indicates whether the application icon is visible in the Dock.
 
virtual std::string badgeText ()=0
 Returns the text displayed in the application dock icon badge.
 
virtual void setBadgeText (const std::string &text)=0
 Sets the application dock icon badge text.
 

Detailed Description

Allows controlling application icon in the Dock on macOS.

Member Function Documentation

◆ hide()

virtual void molybden::Dock::hide ( )
pure virtual

Hides the application icon in the Dock.

When you hide the application icon in the Dock, the application menu bar will be hidden automatically.

Does nothing on Windows and Linux.

◆ isVisible()

virtual bool molybden::Dock::isVisible ( )
pure virtual

Indicates whether the application icon is visible in the Dock.

On Windows and Linux always returns false.

◆ setBadgeText()

virtual void molybden::Dock::setBadgeText ( const std::string &  text)
pure virtual

Sets the application dock icon badge text.

The badge appearance is system defined. This is often used to show an unread count in the application dock icon.

Parameters
labelthe string to be displayed in the badge.

◆ show()

virtual void molybden::Dock::show ( )
pure virtual

Shows the application icon in the Dock.

When you show the application icon in the Dock, the application menu bar will be shown automatically.

Does nothing on Windows and Linux.


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