Wt  4.13.1
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Wt::WFaviconPair Class Reference

A WFavicon switching between two favicons. More...

#include <Wt/WFaviconPair.h>

Inheritance diagram for Wt::WFaviconPair:
[legend]

Public Member Functions

 WFaviconPair (std::unique_ptr< WFavicon > defaultFavicon, std::unique_ptr< WFavicon > updatedFavicon)
 Constructs a WFaviconPair.
 
void setDefaultFavicon (std::unique_ptr< WFavicon > defaultFavicon)
 Sets the default favicon.
 
WFavicondefaultFavicon () const
 Returns the default favicon.
 
void setUpdatedFavicon (std::unique_ptr< WFavicon > updatedFavicon)
 Sets the updated favicon.
 
WFaviconupdatedFavicon () const
 Returns the updated favicon.
 
WFaviconcurrentFavicon () const
 Returns the current favicon used.
 
std::string url () const override
 Returns the url to the favicon.
 
- Public Member Functions inherited from Wt::WFavicon
void update ()
 Sets the favicon in its update state.
 
void reset ()
 Sets the favicon in its default state.
 
bool isUpdated () const
 Returns whether the favicon is in its update state or not.
 

Additional Inherited Members

- Protected Member Functions inherited from Wt::WFavicon
virtual void doUpdate ()
 Updates the favicon.
 
virtual void doReset ()
 Resets the favicon.
 

Detailed Description

A WFavicon switching between two favicons.

This is a WFavicon that uses a different WFavicon for its default and updated state.

See also
WApplication::setFavicon()

Constructor & Destructor Documentation

◆ WFaviconPair()

Wt::WFaviconPair::WFaviconPair ( std::unique_ptr< WFavicon defaultFavicon,
std::unique_ptr< WFavicon updatedFavicon 
)

Constructs a WFaviconPair.

Constructs a WFaviconPair from two WFavicon.

Member Function Documentation

◆ currentFavicon()

WFavicon * Wt::WFaviconPair::currentFavicon ( ) const

Returns the current favicon used.

See also
setUpdatedFavicon(), setDefaultFavicon()

◆ defaultFavicon()

WFavicon * Wt::WFaviconPair::defaultFavicon ( ) const

Returns the default favicon.

See also
setDefaultFavicon()

◆ updatedFavicon()

WFavicon * Wt::WFaviconPair::updatedFavicon ( ) const

Returns the updated favicon.

See also
setUpdatedFavicon()

◆ url()

std::string Wt::WFaviconPair::url ( ) const
overridevirtual

Returns the url to the favicon.

This should return the absolute url to the favicon.

Implements Wt::WFavicon.