fawkes::Throbber Class Reference

#include <throbber.h>

List of all members.

Public Member Functions
bool	anim_running ()
void	set_stock (const Gtk::StockID &stock_id)
void	set_timeout (unsigned int timeout)
void	start_anim ()
void	stop_anim ()
	Throbber (Gtk::IconSize &icon_size)
Private Member Functions
void	ctor (Gtk::IconSize icon_size)
bool	draw_next ()
Private Attributes
unsigned int	__current
Gtk::IconSize	__icon_size
std::vector< Glib::RefPtr < Gdk::Pixbuf > >	__pixbufs
unsigned int	__timeout
sigc::connection	__timeout_connection

---

Detailed Description

Simple Gtk Throbber/Spinner. The throbber shows a spinning icon as a small image. It has been specifically prepared to be used as a custom image Gtk::ToolItem in a Gtk::Toolbar. The icon is defined by the currently active Gtk theme.

Author:

Tim Niemueller

Definition at line 36 of file throbber.h.

---

Constructor & Destructor Documentation

fawkes::Throbber::Throbber

(

Gtk::IconSize &

icon_size

)

Constructor.

Parameters:

icon_size

desired icon size. Be aware that the icon may not be available in all sizes in the current theme.

Definition at line 85 of file throbber.cpp.

---

Member Function Documentation

bool fawkes::Throbber::anim_running

(

)

Check if animation is running.

Returns:

true if animation is currently running, false otherwise.

Definition at line 184 of file throbber.cpp.

void fawkes::Throbber::ctor

(

Gtk::IconSize

icon_size

)

[private]

Definition at line 92 of file throbber.cpp.

bool fawkes::Throbber::draw_next

(

)

[private]

Draw next image.

Returns:

always true

Definition at line 157 of file throbber.cpp.

void fawkes::Throbber::set_stock

(

const Gtk::StockID &

stock_id

)

Set image from stock ID. The image will be overwritten by a running animation or when the animation is started again. It will not be automatically reset to this stock ID if the animation stops, rather you have to do this by yourself.

Parameters:

stock_id

stock ID of image to set

Definition at line 219 of file throbber.cpp.

void fawkes::Throbber::set_timeout

(

unsigned int

timeout

)

Set the animation timeout. The animation timeout is the time between two frames. It defaults to 100ms.

Parameters:

timeout

new timeout for animation in ms

Definition at line 174 of file throbber.cpp.

void fawkes::Throbber::start_anim

(

)

Start animation.

Definition at line 191 of file throbber.cpp.

void fawkes::Throbber::stop_anim

(

)

Stop animation.

Definition at line 201 of file throbber.cpp.

---

Member Data Documentation

unsigned int fawkes::Throbber::__current [private]

Definition at line 59 of file throbber.h.

Gtk::IconSize fawkes::Throbber::__icon_size [private]

Definition at line 61 of file throbber.h.

std::vector<Glib::RefPtr<Gdk::Pixbuf> > fawkes::Throbber::__pixbufs [private]

Definition at line 60 of file throbber.h.

unsigned int fawkes::Throbber::__timeout [private]

Definition at line 64 of file throbber.h.

sigc::connection fawkes::Throbber::__timeout_connection [private]

Definition at line 63 of file throbber.h.

---

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

• throbber.h
• throbber.cpp