foobar2000 SDK  2015-08-03
Public Member Functions
ui_status_text_overrideabstract

#include <ui.h>

+ Inheritance diagram for ui_status_text_override:

Public Member Functions

 FB2K_MAKE_SERVICE_INTERFACE (ui_status_text_override, service_base)
 
virtual void override_text (const char *p_message)=0
 
virtual void revert_text ()=0
 
- Public Member Functions inherited from service_base
template<typename outPtr_t >
bool cast (outPtr_t &outPtr)
 
virtual int service_add_ref ()=0 throw ()
 
virtual bool service_query (service_ptr_t< service_base > &p_out, const GUID &p_guid)
 
template<class T >
bool service_query_t (service_ptr_t< T > &p_out)
 
virtual int service_release ()=0 throw ()
 

Additional Inherited Members

- Public Types inherited from service_base
typedef service_base t_interface
 
- Protected Member Functions inherited from service_base
 service_base ()
 
 ~service_base ()
 

Detailed Description

Interface class allowing you to override UI statusbar text. There may be multiple callers trying to override statusbar text; backend decides which one succeeds so you will not always get what you want. Statusbar text override is automatically cancelled when the object is released.
Use ui_control::override_status_text_create() to instantiate. Implemented by core. Do not reimplement.

Definition at line 47 of file ui.h.

Member Function Documentation

ui_status_text_override::FB2K_MAKE_SERVICE_INTERFACE ( ui_status_text_override  ,
service_base   
)
virtual void ui_status_text_override::override_text ( const char *  p_message)
pure virtual

Sets statusbar text to specified UTF-8 null-terminated string.

virtual void ui_status_text_override::revert_text ( )
pure virtual

Cancels statusbar text override.


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