Added some documentation to menu-bbutton.hpp
This commit is contained in:
parent
be8d7644ed
commit
58d2f05db4
1 changed files with 22 additions and 0 deletions
|
|
@ -71,15 +71,37 @@ public:
|
||||||
**/
|
**/
|
||||||
Gtk::Menu& get_menu();
|
Gtk::Menu& get_menu();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pops up the menu.
|
||||||
|
**/
|
||||||
void popup();
|
void popup();
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An event handler for when the button is pressed.
|
||||||
|
**/
|
||||||
virtual void on_pressed();
|
virtual void on_pressed();
|
||||||
|
|
||||||
private:
|
private:
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A callback function used to determine the correct position for the
|
||||||
|
* popup menu.
|
||||||
|
* @param x The x-coordinate to display the menu in root window
|
||||||
|
* coordinates.
|
||||||
|
* @param y The y-coordinate to display the menu in root window
|
||||||
|
* coordinates.
|
||||||
|
* @param push_in This value is set to true if the menu should be
|
||||||
|
* pushed in if it collides with the edge of the screen.
|
||||||
|
**/
|
||||||
void on_menu_position(int& x, int& y, bool& push_in);
|
void on_menu_position(int& x, int& y, bool& push_in);
|
||||||
|
|
||||||
private:
|
private:
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The internal menu object which is the popup menu of this widget.
|
||||||
|
**/
|
||||||
Gtk::Menu menu;
|
Gtk::Menu menu;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue