AbstractBrowser Class Reference

Inherit from this class in order to be able to add the browser to the browserlist. More...

#include <AbstractBrowser.hh>

Inheritance diagram for AbstractBrowser:

Public Member Functions
	AbstractBrowser (const char *name, bool is_visible, bool needs_connection, Gtk::StockID icon)
	Inherit from this class to be able to add this browser to the browserlist.
virtual Gtk::Widget *	get_container ()=0
	Tell BrowserList which element to manage.
Glib::ustring &	get_name ()
	Get the name of the browser (shown in the browserlist)
Gtk::StockID	get_icon_stock_id ()
	Returns the set icon for this browser.
bool	is_visible ()
	Tells if browser is visible in browserlist.
bool	needs_connection ()
	If this browser works without a connection (if false)
bool	is_active ()
void	on_getting_active ()
Friends
class	GManager::BrowserList

---

Detailed Description

Inherit from this class in order to be able to add the browser to the browserlist.

Definition at line 41 of file AbstractBrowser.hh.

---

Constructor & Destructor Documentation

AbstractBrowser::AbstractBrowser	(	const char *	name,
		bool	is_visible,
		bool	needs_connection,
		Gtk::StockID	icon
	)		[inline]

Inherit from this class to be able to add this browser to the browserlist.

Parameters:

name	The name shown in the list
is_visible	if it is visible in the list (most likely true)
needs_connection	false if this browser works withouth a connection
icon	the icon shown lefthand to the name

Definition at line 55 of file AbstractBrowser.hh.

---

Member Function Documentation

virtual Gtk::Widget* AbstractBrowser::get_container

(

)

[pure virtual]

Tell BrowserList which element to manage.

You are supposed to override this.

Returns:

A reference to the containing widget of the browser

Implemented in Browser::Database, Browser::PlaylistManager, Browser::Settings, Browser::Fortuna, Browser::NowPlaying, Browser::Queue, and Browser::StatBrowser.

Gtk::StockID AbstractBrowser::get_icon_stock_id

(

)

[inline]

Returns the set icon for this browser.

Returns:

See above.

Definition at line 92 of file AbstractBrowser.hh.

Glib::ustring& AbstractBrowser::get_name

(

)

[inline]

Get the name of the browser (shown in the browserlist)

Note: You do NOT need to override this.

Returns:

a reference to a ustring

Definition at line 82 of file AbstractBrowser.hh.

bool AbstractBrowser::is_active

(

)

[inline]

Definition at line 117 of file AbstractBrowser.hh.

bool AbstractBrowser::is_visible

(

)

[inline]

Tells if browser is visible in browserlist.

Returns:

a boolean

Definition at line 102 of file AbstractBrowser.hh.

bool AbstractBrowser::needs_connection

(

)

[inline]

If this browser works without a connection (if false)

Returns:

a boolean

Definition at line 112 of file AbstractBrowser.hh.

void AbstractBrowser::on_getting_active

(

)

[inline]

Definition at line 122 of file AbstractBrowser.hh.

---

Friends And Related Function Documentation

friend class GManager::BrowserList [friend]

Definition at line 45 of file AbstractBrowser.hh.

---

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

• src/Browser/AbstractBrowser.hh