Tooltips
Tooltips are the little information windows that pop up when you leave your pointer over a widget for a few seconds. Use set_tooltip_text() to set a text string as a tooltip on any Widget. Gtk::ToolItems are not Widgets, but have the same method for convenience. Gtk::Tooltip is used for more advanced tooltip usage, such as showing an image as well as text.
- 7.6.1. Example
7.6.1. Example
File: examplewindow.h (For use with gtkmm 3, not gtkmm 2)
#ifndef GTKMM_EXAMPLEWINDOW_H #define GTKMM_EXAMPLEWINDOW_H #include <gtkmm.h> class ExampleWindow : public Gtk::Window { public: ExampleWindow(); virtual ~ExampleWindow(); protected: //Methods: void prepare_textview(); void connect_signals(); //Signal handlers: void on_markup_checkbutton_click(); bool on_textview_query_tooltip(int x, int y, bool keyboard_tooltip, const Glib::RefPtr<Gtk::Tooltip>& tooltip); bool on_button_query_tooltip(int x, int y, bool keyboard_tooltip, const Glib::RefPtr<Gtk::Tooltip>& tooltip); //Child widgets: Gtk::Box m_vbox; Gtk::CheckButton m_checkbutton; Gtk::Label m_label; Gtk::ScrolledWindow m_scrolled_window; Gtk::TextView m_text_view; Glib::RefPtr<Gtk::TextBuffer> m_ref_text_buffer; Glib::RefPtr<Gtk::TextTag> m_ref_bold_tag; Gtk::Button m_button; Gtk::Window m_button_tooltip_window; }; #endif // GTKMM_EXAMPLEWINDOW_H
File: examplewindow.cc (For use with gtkmm 3, not gtkmm 2)
#include "examplewindow.h" #include <vector> const Glib::ustring app_title = "gtkmm tooltips example"; const Glib::ustring non_markedup_tip = "A tooltip without markup."; const Glib::ustring markedup_tip = "<i>Markup</i> in a tooltip."; ExampleWindow::ExampleWindow() : m_vbox(Gtk::ORIENTATION_VERTICAL, 3), m_checkbutton("Click to alternate markup in tooltip"), m_label("A label"), m_button("Custom widget in tooltip window"), m_button_tooltip_window(Gtk::WINDOW_POPUP) { //Set up window and the top-level container: set_title(app_title); set_border_width(10); add(m_vbox); //Check button with markup in tooltip: m_checkbutton.set_tooltip_text(non_markedup_tip); m_vbox.pack_start(m_checkbutton, Gtk::PACK_SHRINK); //Label: m_label.set_tooltip_text("Another tooltip"); m_vbox.pack_start(m_label, Gtk::PACK_SHRINK); //Textview: prepare_textview(); //Button: // set_tooltip_window(), like set_tooltip_text(), // will call set_has_tooltip() for us. m_button.set_tooltip_window(m_button_tooltip_window); m_vbox.pack_start(m_button, Gtk::PACK_SHRINK); //Button's custom tooltip window: m_button_tooltip_window.set_default_size(250, 30); Gtk::Label* label = Gtk::manage(new Gtk::Label("A label in a custom tooltip window")); label->show(); m_button_tooltip_window.add(*label); connect_signals(); show_all_children(); } ExampleWindow::~ExampleWindow() { } void ExampleWindow::prepare_textview() { Gtk::TextIter iter; std::vector< Glib::RefPtr<Gtk::TextTag> > tags; //Set up a scrolled window: m_scrolled_window.add(m_text_view); m_scrolled_window.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC); m_vbox.pack_start(m_scrolled_window); //Create a text buffer with some text: m_ref_text_buffer = Gtk::TextBuffer::create(); iter = m_ref_text_buffer->end(); m_ref_text_buffer->insert(iter, "Hover over the text "); //Insert some text with a tag. //In the tooltip signal handler below, we will show a tooltip //when mouse pointer is above this tagged text. m_ref_bold_tag = m_ref_text_buffer->create_tag("bold"); m_ref_bold_tag->set_property("weight", Pango::WEIGHT_BOLD); tags.push_back(m_ref_bold_tag); iter = m_ref_text_buffer->end(); m_ref_text_buffer->insert_with_tags(iter, "in bold", tags); iter = m_ref_text_buffer->end(); m_ref_text_buffer->insert(iter, " to see its tooltip"); m_text_view.set_buffer(m_ref_text_buffer); m_text_view.set_size_request(320, 50); //When only connecting to the query-tooltip signal, and not using any //of set_tooltip_text(), set_tooltip_markup() or set_tooltip_window(), //we need to explicitly tell GTK+ that the widget has a tooltip which //we'll show. m_text_view.set_has_tooltip(); } void ExampleWindow::connect_signals() { m_checkbutton.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_markup_checkbutton_click)); m_text_view.signal_query_tooltip().connect( sigc::mem_fun(*this, &ExampleWindow::on_textview_query_tooltip)); m_button.signal_query_tooltip().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_query_tooltip)); } void ExampleWindow::on_markup_checkbutton_click() { if (m_checkbutton.get_active() == true) { m_checkbutton.set_tooltip_markup(markedup_tip); } else { m_checkbutton.set_tooltip_markup(non_markedup_tip); } } bool ExampleWindow::on_textview_query_tooltip(int x, int y, bool keyboard_tooltip, const Glib::RefPtr<Gtk::Tooltip>& tooltip) { Gtk::TextIter iter; if (keyboard_tooltip) { int offset = m_ref_text_buffer->property_cursor_position().get_value(); iter = m_ref_text_buffer->get_iter_at_offset(offset); } else { int mouse_x, mouse_y, trailing; m_text_view.window_to_buffer_coords(Gtk::TEXT_WINDOW_TEXT, x, y, mouse_x, mouse_y); m_text_view.get_iter_at_position(iter, trailing, mouse_x, mouse_y); } //Show a tooltip if the cursor or mouse pointer is over the text //with the specific tag: if (iter.has_tag(m_ref_bold_tag)) { tooltip->set_markup("<b>Information</b> attached to a text tag"); tooltip->set_icon_from_icon_name("dialog-information", Gtk::ICON_SIZE_MENU); } else { return false; } return true; } bool ExampleWindow::on_button_query_tooltip(int, int, bool, const Glib::RefPtr<Gtk::Tooltip>&) { //We already have a custom window ready, just return true to show it: return true; }
File: main.cc (For use with gtkmm 3, not gtkmm 2)
#include "examplewindow.h" #include <gtkmm/application.h> int main(int argc, char *argv[]) { Glib::RefPtr<Gtk::Application> app = Gtk::Application::create(argc, argv, "org.gtkmm.example"); ExampleWindow window; //Shows the window and returns when it is closed. return app->run(window); }