Improved ButtonBar documentation

This commit is contained in:
Joel Holdsworth 2009-03-14 14:29:59 +00:00
parent d15264fd67
commit babb46a4ad
2 changed files with 24 additions and 1 deletions

View file

@ -42,11 +42,24 @@ public:
**/
ButtonBar();
/**
* Append a button to the button bar.
* @param button The button to append.
**/
void append(MiniButton& button);
/**
* Append a button to the button bar, and connect a click event.
* @param button The button to append.
* @param clicked_slot The slot to connect.
**/
void append(MiniButton& button,
const sigc::slot<void>& clicked_slot);
/**
* Append a sererator item.
* @param seperator The seperator to append.
**/
void append(Gtk::SeparatorToolItem &seperator);
};

View file

@ -41,17 +41,27 @@ public:
/**
* Creates a new Button containing the image and text from a stock
* item.
* @param stock_id The stock_id of the image.
* @param icon_size The size of the image to show.
* @remarks Stock ids have identifiers like Gtk::Stock::OK and
* Gtk::Stock::APPLY.
**/
MiniButton(const Gtk::StockID& stock_id,
const Gtk::IconSize icon_size = Gtk::ICON_SIZE_LARGE_TOOLBAR);
/**
* Sets a new image from a stock-id for this button.
* @param stock_id The stock_id of the image.
* @param icon_size The size of the image to show.
**/
void set_stock_id(const Gtk::StockID& stock_id,
const Gtk::IconSize icon_size = Gtk::ICON_SIZE_LARGE_TOOLBAR);
private:
/**
* The image widget for the button.
**/
Gtk::Image image;
};