gtkmm: Gtk::AboutDialog Class Reference

The AboutDialog offers a simple way to display information about a program like its logo, name, copyright, website and license. More...

#include <gtkmm/aboutdialog.h>

Inheritance diagram for Gtk::AboutDialog:

Public Member Functions

 AboutDialog (AboutDialog&& src) noexcept
 
AboutDialogoperator= (AboutDialog&& src) noexcept
 
 AboutDialog (const AboutDialog&)=delete
 
AboutDialogoperator= (const AboutDialog&)=delete
 
 ~AboutDialog () noexcept override
 
GtkAboutDialog* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkAboutDialog* gobj () const
 Provides access to the underlying C GObject. More...

 
 AboutDialog ()
 
 AboutDialog (bool use_header_bar)
 Constructor. More...

 
Glib::ustring get_program_name () const
 Returns the program name displayed in the about dialog. More...

 
void set_program_name (const Glib::ustring& name)
 Sets the name to display in the about dialog. More...

 
Glib::ustring get_version () const
 Returns the version string. More...

 
void set_version (const Glib::ustring& version)
 Sets the version string to display in the about dialog. More...

 
Glib::ustring get_copyright () const
 Returns the copyright string. More...

 
void set_copyright (const Glib::ustring& copyright)
 Sets the copyright string to display in the about dialog. More...

 
Glib::ustring get_comments () const
 Returns the comments string. More...

 
void set_comments (const Glib::ustring& comments)
 Sets the comments string to display in the about dialog. More...

 
Glib::ustring get_license () const
 Returns the license information. More...

 
void set_license (const Glib::ustring& license)
 Sets the license information to be displayed in the secondary license dialog. More...

 
License get_license_type () const
 Retrieves the license set using set_license_type() More...

 
void set_license_type (License license_type)
 Sets the license of the application showing the about dialog from a list of known licenses. More...

 
Glib::ustring get_system_information () const
 Returns the system information that is shown in the about dialog. More...

 
void set_system_information (const Glib::ustring& system_information)
 Sets the system information to be displayed in the about dialog. More...

 
Glib::ustring get_website () const
 Returns the website URL. More...

 
void set_website (const Glib::ustring& website)
 Sets the URL to use for the website link. More...

 
Glib::ustring get_website_label () const
 Returns the label used for the website link. More...

 
void set_website_label (const Glib::ustring& website_label)
 Sets the label to be used for the website link. More...

 
std::vector< Glib::ustringget_authors () const
 Returns the string which are displayed in the authors tab of the secondary credits dialog. More...

 
void set_authors (const std::vector< Glib::ustring >& authors) const
 Sets the strings which are displayed in the authors tab of the secondary credits dialog. More...

 
std::vector< Glib::ustringget_documenters () const
 Returns the string which are displayed in the documenters tab of the secondary credits dialog. More...

 
void set_documenters (const std::vector< Glib::ustring >& documenters)
 Sets the strings which are displayed in the documenters tab of the credits dialog. More...

 
std::vector< Glib::ustringget_artists () const
 Returns the string which are displayed in the artists tab of the secondary credits dialog. More...

 
void set_artists (const std::vector< Glib::ustring >& artists)
 Sets the strings which are displayed in the artists tab of the secondary credits dialog. More...

 
Glib::ustring get_translator_credits () const
 Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog. More...

 
void set_translator_credits (const Glib::ustring& translator_credits)
 Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog. More...

 
Glib::RefPtr< Gdk::Paintableget_logo ()
 Returns the paintable displayed as logo in the about dialog. More...

 
Glib::RefPtr< const Gdk::Paintableget_logo () const
 Returns the paintable displayed as logo in the about dialog. More...

 
void set_logo (const Glib::RefPtr< const Gdk::Paintable >& logo)
 Sets the surface to be displayed as logo in the about dialog. More...

 
void set_logo_default ()
 Sets the surface to be displayed as logo in the about dialog. More...

 
Glib::ustring get_logo_icon_name () const
 Returns the icon name displayed as logo in the about dialog. More...

 
void set_logo_icon_name (const Glib::ustring& icon_name)
 Sets the surface to be displayed as logo in the about dialog. More...

 
bool get_wrap_license () const
 Returns whether the license text in about is automatically wrapped. More...

 
void set_wrap_license (bool wrap_license)
 Sets whether the license text in about is automatically wrapped. More...

 
void add_credit_section (const Glib::ustring& section_name, const std::vector< Glib::ustring >& people)
 Creates a new section in the Credits page. More...

 
Glib::PropertyProxy< Glib::ustringproperty_program_name ()
 The name of the program. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_program_name () const
 The name of the program. More...

 
Glib::PropertyProxy< Glib::ustringproperty_version ()
 The version of the program. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_version () const
 The version of the program. More...

 
Glib::PropertyProxy< Glib::ustringproperty_copyright ()
 Copyright information for the program. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_copyright () const
 Copyright information for the program. More...

 
Glib::PropertyProxy< Glib::ustringproperty_comments ()
 Comments about the program. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_comments () const
 Comments about the program. More...

 
Glib::PropertyProxy< Glib::ustringproperty_website ()
 The URL for the link to the website of the program. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_website () const
 The URL for the link to the website of the program. More...

 
Glib::PropertyProxy< Glib::ustringproperty_website_label ()
 The label for the link to the website of the program. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_website_label () const
 The label for the link to the website of the program. More...

 
Glib::PropertyProxy< Glib::ustringproperty_license ()
 The license of the program. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_license () const
 The license of the program. More...

 
Glib::PropertyProxy< Licenseproperty_license_type ()
 The license of the program, as a value of the Gtk::License enumeration. More...

 
Glib::PropertyProxy_ReadOnly< Licenseproperty_license_type () const
 The license of the program, as a value of the Gtk::License enumeration. More...

 
Glib::PropertyProxy< Glib::ustringproperty_system_information ()
 Information about the system on which the program is running. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_system_information () const
 Information about the system on which the program is running. More...

 
Glib::PropertyProxy< std::vector< Glib::ustring > > property_authors ()
 The authors of the program, as a nullptr-terminated array of strings. More...

 
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > property_authors () const
 The authors of the program, as a nullptr-terminated array of strings. More...

 
Glib::PropertyProxy< std::vector< Glib::ustring > > property_documenters ()
 The people documenting the program, as a nullptr-terminated array of strings. More...

 
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > property_documenters () const
 The people documenting the program, as a nullptr-terminated array of strings. More...

 
Glib::PropertyProxy< std::vector< Glib::ustring > > property_translator_credits ()
 Credits to the translators. More...

 
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > property_translator_credits () const
 Credits to the translators. More...

 
Glib::PropertyProxy< std::vector< Glib::ustring > > property_artists ()
 The people who contributed artwork to the program, as a nullptr-terminated array of strings. More...

 
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > property_artists () const
 The people who contributed artwork to the program, as a nullptr-terminated array of strings. More...

 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Paintable > > property_logo ()
 A logo for the about box. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Paintable > > property_logo () const
 A logo for the about box. More...

 
Glib::PropertyProxy< Glib::ustringproperty_logo_icon_name ()
 A named icon to use as the logo for the about box. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_logo_icon_name () const
 A named icon to use as the logo for the about box. More...

 
Glib::PropertyProxy< bool > property_wrap_license ()
 Whether to wrap the text in the license dialog. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_wrap_license () const
 Whether to wrap the text in the license dialog. More...

 
Glib::SignalProxy< bool(const std::string&)> signal_activate_link ()
 
- Public Member Functions inherited from Gtk::Dialog
 Dialog (Dialog&& src) noexcept
 
Dialogoperator= (Dialog&& src) noexcept
 
 Dialog (const Dialog&)=delete
 
Dialogoperator= (const Dialog&)=delete
 
 ~Dialog () noexcept override
 
GtkDialog* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkDialog* gobj () const
 Provides access to the underlying C GObject. More...

 
 Dialog ()
 
 Dialog (const Glib::ustring& title, bool modal=false, bool use_header_bar=false)
 
 Dialog (const Glib::ustring& title, Gtk::Window& parent, bool modal=false, bool use_header_bar=false)
 
void add_action_widget (Widget& child, int response_id)
 Adds an activatable widget to the action area of a Gtk::Dialog, connecting a signal handler that will emit the Gtk::Dialog::signal_response() signal on the dialog when the widget is activated. More...

 
Buttonadd_button (const Glib::ustring& button_text, int response_id)
 Adds a button with the given text and sets things up so that clicking the button will emit the Gtk::Dialog::signal_response() signal with the given response_id. More...

 
void set_response_sensitive (int response_id, bool setting=true)
 Calls gtk_widget_set_sensitive (widget, @a setting) for each widget in the dialog’s action area with the given response_id. More...

 
void set_default_response (int response_id)
 Sets the last widget in the dialog’s action area with the given response_id as the default widget for the dialog. More...

 
Widgetget_widget_for_response (int response_id)
 Gets the widget button that uses the given response ID in the action area of a dialog. More...

 
const Widgetget_widget_for_response (int response_id) const
 Gets the widget button that uses the given response ID in the action area of a dialog. More...

 
int get_response_for_widget (const Gtk::Widget& widget) const
 Gets the response id of a widget in the action area of a dialog. More...

 
void response (int response_id)
 Emits the Gtk::Dialog::signal_response() signal with the given response ID. More...

 
int run ()
 Blocks in a recursive main loop until the dialog either emits the Gtk::Dialog::signal_response() signal, or is destroyed. More...

 
Boxget_content_area ()
 Returns the content area of dialog. More...

 
const Boxget_content_area () const
 Returns the content area of dialog. More...

 
HeaderBarget_header_bar ()
 Returns the header bar of dialog. More...

 
const HeaderBarget_header_bar () const
 Returns the header bar of dialog. More...

 
Glib::SignalProxy< void(int)> signal_response ()
 
Glib::PropertyProxy_ReadOnly< bool > property_use_header_bar () const
 true if the dialog uses a Gtk::HeaderBar for action buttons instead of the action-area. More...

 
- Public Member Functions inherited from Gtk::Window
 Window (Window&& src) noexcept
 
Windowoperator= (Window&& src) noexcept
 
 Window (const Window&)=delete
 
Windowoperator= (const Window&)=delete
 
 ~Window () noexcept override
 
GtkWindow* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkWindow* gobj () const
 Provides access to the underlying C GObject. More...

 
 Window (WindowType type=WindowType::TOPLEVEL)
 
Glib::PropertyProxy_ReadOnly< WindowTypeproperty_type () const
 The type of the window. More...

 
Glib::PropertyProxy< Glib::ustringproperty_title ()
 The title of the window. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_title () const
 The title of the window. More...

 
Glib::PropertyProxy_WriteOnly< Glib::ustringproperty_startup_id ()
 The :startup-id is a write-only property for setting window's startup notification identifier. More...

 
Glib::PropertyProxy< bool > property_resizable ()
 If true, users can resize the window. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_resizable () const
 If true, users can resize the window. More...

 
Glib::PropertyProxy< bool > property_modal ()
 If true, the window is modal (other windows are not usable while this one is up). More...

 
Glib::PropertyProxy_ReadOnly< bool > property_modal () const
 If true, the window is modal (other windows are not usable while this one is up). More...

 
Glib::PropertyProxy< WindowPositionproperty_window_position ()
 The initial position of the window. More...

 
Glib::PropertyProxy_ReadOnly< WindowPositionproperty_window_position () const
 The initial position of the window. More...

 
Glib::PropertyProxy< int > property_default_width ()
 The default width of the window, used when initially showing the window. More...

 
Glib::PropertyProxy_ReadOnly< int > property_default_width () const
 The default width of the window, used when initially showing the window. More...

 
Glib::PropertyProxy< int > property_default_height ()
 The default height of the window, used when initially showing the window. More...

 
Glib::PropertyProxy_ReadOnly< int > property_default_height () const
 The default height of the window, used when initially showing the window. More...

 
Glib::PropertyProxy< bool > property_destroy_with_parent ()
 If this window should be destroyed when the parent is destroyed. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_destroy_with_parent () const
 If this window should be destroyed when the parent is destroyed. More...

 
Glib::PropertyProxy< bool > property_hide_on_close ()
 If this window should be hidden when the user clicks the close button. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_hide_on_close () const
 If this window should be hidden when the user clicks the close button. More...

 
Glib::PropertyProxy< bool > property_mnemonics_visible ()
 Whether mnemonics are currently visible in this window. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_mnemonics_visible () const
 Whether mnemonics are currently visible in this window. More...

 
Glib::PropertyProxy< Glib::ustringproperty_icon_name ()
 The :icon-name property specifies the name of the themed icon to use as the window icon. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_icon_name () const
 The :icon-name property specifies the name of the themed icon to use as the window icon. More...

 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Display > > property_display ()
 The display that will display this window. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Display > > property_display () const
 The display that will display this window. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_is_active () const
 Whether the toplevel is the current active window. More...

 
Glib::PropertyProxy< Gdk::Surface::TypeHintproperty_type_hint ()
 Hint to help the desktop environment understand what kind of window this is and how to treat it. More...

 
Glib::PropertyProxy_ReadOnly< Gdk::Surface::TypeHintproperty_type_hint () const
 Hint to help the desktop environment understand what kind of window this is and how to treat it. More...

 
Glib::PropertyProxy< bool > property_decorated ()
 Whether the window should be decorated by the window manager. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_decorated () const
 Whether the window should be decorated by the window manager. More...

 
Glib::PropertyProxy< Window* > property_transient_for ()
 The transient parent of the window. More...

 
Glib::PropertyProxy_ReadOnly< Window* > property_transient_for () const
 The transient parent of the window. More...

 
Glib::PropertyProxy< bool > property_accept_focus ()
 Whether the window should receive the input focus. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_accept_focus () const
 Whether the window should receive the input focus. More...

 
Glib::PropertyProxy< bool > property_focus_on_map ()
 Whether the window should receive the input focus when mapped. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_focus_on_map () const
 Whether the window should receive the input focus when mapped. More...

 
Glib::PropertyProxy< bool > property_deletable ()
 Whether the window frame should have a close button. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_deletable () const
 Whether the window frame should have a close button. More...

 
Glib::PropertyProxy< Glib::RefPtr< Application > > property_application ()
 The Gtk::Application associated with the window. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Application > > property_application () const
 The Gtk::Application associated with the window. More...

 
Glib::PropertyProxy< bool > property_focus_visible ()
 Whether 'focus rectangles' are currently visible in this window. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_focus_visible () const
 Whether 'focus rectangles' are currently visible in this window. More...

 
Glib::PropertyProxy< Widget* > property_attached_to ()
 The widget to which this window is attached. More...

 
Glib::PropertyProxy_ReadOnly< Widget* > property_attached_to () const
 The widget to which this window is attached. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_is_maximized () const
 Whether the window is maximized. More...

 
Glib::PropertyProxy< Widget* > property_default_widget ()
 The default widget. More...

 
Glib::PropertyProxy_ReadOnly< Widget* > property_default_widget () const
 The default widget. More...

 
Glib::SignalProxy< void()> signal_keys_changed ()
 
Glib::SignalProxy< bool()> signal_close_request ()
 
void set_title (const Glib::ustring& title)
 Sets the title of the Gtk::Window. More...

 
Glib::ustring get_title () const
 Retrieves the title of the window. More...

 
void set_startup_id (const Glib::ustring& startup_id)
 Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. More...

 
void add_accel_group (const Glib::RefPtr< AccelGroup >& accel_group)
 Associate accel_group with window, such that calling gtk_accel_groups_activate() on window will activate accelerators in accel_group. More...

 
void remove_accel_group (const Glib::RefPtr< AccelGroup >& accel_group)
 Reverses the effects of add_accel_group(). More...

 
void set_position (WindowPosition position)
 Sets a position constraint for this window. More...

 
void set_focus (Gtk::Widget& focus)
 If focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. More...

 
void unset_focus ()
 
Widgetget_focus ()
 Retrieves the current focused widget within the window. More...

 
const Widgetget_focus () const
 Retrieves the current focused widget within the window. More...

 
void set_default_widget (Gtk::Widget& default_widget)
 The default widget is the widget that’s activated when the user presses Enter in a dialog (for example). More...

 
void unset_default_widget ()
 
Widgetget_default_widget ()
 Returns the default widget for window. More...

 
const Widgetget_default_widget () const
 Returns the default widget for window. More...

 
void set_transient_for (Window& parent)
 Dialog windows should be set transient for the main application window they were spawned from. More...

 
void unset_transient_for ()
 Unsets the current transient window. More...

 
Windowget_transient_for ()
 Fetches the transient parent for this window. More...

 
const Windowget_transient_for () const
 Fetches the transient parent for this window. More...

 
void unset_attached_to ()
 Unsets the attached-to widget. More...

 
void set_attached_to (Widget& attach_widget)
 Marks window as attached to attach_widget. More...

 
Widgetget_attached_to ()
 Fetches the attach widget for this window. More...

 
const Widgetget_attached_to () const
 Fetches the attach widget for this window. More...

 
void set_type_hint (Gdk::Surface::TypeHint hint)
 By setting the type hint for the window, you allow the window manager to decorate and handle the window in a way which is suitable to the function of the window in your application. More...

 
Gdk::Surface::TypeHint get_type_hint () const
 Gets the type hint for this window. More...

 
void set_accept_focus (bool setting=true)
 Windows may set a hint asking the desktop environment not to receive the input focus. More...

 
bool get_accept_focus () const
 Gets the value set by set_accept_focus(). More...

 
void set_focus_on_map (bool setting=true)
 Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped. More...

 
bool get_focus_on_map () const
 Gets the value set by set_focus_on_map(). More...

 
bool get_destroy_with_parent () const
 Returns whether the window will be destroyed with its transient parent. More...

 
void set_hide_on_close (bool setting=true)
 If setting is true, then clicking the close button on the window will not destroy it, but only hide it. More...

 
bool get_hide_on_close () const
 Returns whether the window will be hidden when the close button is clicked. More...

 
void set_mnemonics_visible (bool setting=true)
 Sets the Gtk::Window::property_mnemonics_visible() property. More...

 
bool get_mnemonics_visible () const
 Gets the value of the Gtk::Window::property_mnemonics_visible() property. More...

 
void set_focus_visible (bool setting=true)
 Sets the Gtk::Window::property_focus_visible() property. More...

 
bool get_focus_visible () const
 Gets the value of the Gtk::Window::property_focus_visible() property. More...

 
void set_resizable (bool resizable=true)
 Sets whether the user can resize a window. More...

 
bool get_resizable () const
 Gets the value set by set_resizable(). More...

 
void set_display (const Glib::RefPtr< Gdk::Display >& display)
 Sets the Gdk::Display where the window is displayed; if the window is already mapped, it will be unmapped, and then remapped on the new display. More...

 
bool is_active () const
 Returns whether the window is part of the current active toplevel. More...

 
void set_decorated (bool setting=true)
 By default, windows are decorated with a title bar, resize controls, etc. More...

 
bool get_decorated () const
 Returns whether the window has been set to have decorations such as a title bar via set_decorated(). More...

 
void set_deletable (bool setting=true)
 By default, windows have a close button in the window frame. More...

 
bool get_deletable () const
 Returns whether the window has been set to have a close button via set_deletable(). More...

 
void set_icon_name (const Glib::ustring& name)
 Sets the icon for the window from a named themed icon. More...

 
Glib::ustring get_icon_name () const
 Returns the name of the themed icon for the window, see set_icon_name(). More...

 
void set_modal (bool modal=true)
 Sets a window modal or non-modal. More...

 
bool get_modal () const
 Returns whether the window is modal. More...

 
void add_mnemonic (guint keyval, Widget& target)
 Adds a mnemonic to this window. More...

 
void remove_mnemonic (guint keyval, Widget& target)
 Removes a mnemonic from this window. More...

 
bool mnemonic_activate (guint keyval, Gdk::ModifierType modifier)
 Activates the targets associated with the mnemonic. More...

 
void set_mnemonic_modifier (Gdk::ModifierType modifier)
 Sets the mnemonic modifier for this window. More...

 
Gdk::ModifierType get_mnemonic_modifier ()
 Returns the mnemonic modifier for this window. More...

 
void present ()
 Presents a window to the user. More...

 
void present (guint32 timestamp)
 Presents a window to the user. More...

 
void iconify ()
 Asks to iconify (i.e. minimize) the specified window. More...

 
void deiconify ()
 Asks to deiconify (i.e. unminimize) the specified window. More...

 
void stick ()
 Asks to stick window, which means that it will appear on all user desktops. More...

 
void unstick ()
 Asks to unstick window, which means that it will appear on only one of the user’s desktops. More...

 
void maximize ()
 Asks to maximize window, so that it becomes full-screen. More...

 
void unmaximize ()
 Asks to unmaximize window. More...

 
void fullscreen ()
 Asks to place window in the fullscreen state. More...

 
void unfullscreen ()
 Asks to toggle off the fullscreen state for window. More...

 
void fullscreen_on_monitor (const Glib::RefPtr< Gdk::Monitor >& monitor)
 Asks to place window in the fullscreen state. More...

 
void close ()
 Requests that the window is closed, similar to what happens when a window manager close button is clicked. More...

 
void begin_resize_drag (Gdk::SurfaceEdge edge, int button, int x, int y, guint32 timestamp)
 Starts resizing a window. More...

 
void begin_move_drag (int button, int x, int y, guint32 timestamp)
 Starts moving a window. More...

 
void set_default_size (int width, int height)
 Sets the default size of a window. More...

 
void get_default_size (int& width, int& height) const
 Gets the default size of the window. More...

 
void resize (int width, int height)
 Resizes the window as if the user had done so, obeying geometry constraints. More...

 
void get_size (int& width, int& height) const
 Obtains the current size of window. More...

 
Glib::RefPtr< WindowGroupget_group ()
 Returns the group for window or the default group, if window is nullptr or if window does not have an explicit window group. More...

 
Glib::RefPtr< const WindowGroupget_group () const
 Returns the group for window or the default group, if window is nullptr or if window does not have an explicit window group. More...

 
bool has_group () const
 Returns whether window has an explicit window group. More...

 
WindowType get_window_type () const
 Gets the type of the window. More...

 
Glib::RefPtr< Applicationget_application ()
 Gets the Gtk::Application associated with the window (if any). More...

 
Glib::RefPtr< const Applicationget_application () const
 Gets the Gtk::Application associated with the window (if any). More...

 
void set_application (const Glib::RefPtr< Application >& application)
 Sets or unsets the Gtk::Application associated with the window. More...

 
void unset_application ()
 Unsets the Application associated with the window. More...

 
void set_keep_above (bool setting=true)
 Asks to keep window above, so that it stays on top. More...

 
void set_keep_below (bool setting=true)
 Asks to keep window below, so that it stays in bottom. More...

 
void set_titlebar (Widget& titlebar)
 Sets a custom titlebar for window. More...

 
Widgetget_titlebar ()
 Returns the custom titlebar that has been set with set_titlebar(). More...

 
const Widgetget_titlebar () const
 Returns the custom titlebar that has been set with set_titlebar(). More...

 
bool is_maximized () const
 Retrieves the current maximized state of window. More...

 
void show_uri (const Glib::ustring& uri, guint32 timestamp)
 This is a convenience function for launching the default application to show the uri. More...

 
std::vector< Glib::RefPtr< AccelGroup > > get_accel_groups ()
 Gets a vector containing each Gtk::AccelGroup associated with the window. More...

 
void raise ()
 Brings the window to the front. More...

 
void set_manage () override
 Overriden to warn that it doesn't make sense to use Gtk::manage() on this class because it has no parent container. More...

 
- Public Member Functions inherited from Gtk::Bin
 Bin (Bin&& src) noexcept
 
Binoperator= (Bin&& src) noexcept
 
 Bin (const Bin&)=delete
 
Binoperator= (const Bin&)=delete
 
 ~Bin () noexcept override
 
GtkBin* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkBin* gobj () const
 Provides access to the underlying C GObject. More...

 
Gtk::Widgetget_child ()
 Gets the child of the Gtk::Bin, or nullptr if the bin contains no child widget. More...

 
const Gtk::Widgetget_child () const
 Gets the child of the Gtk::Bin, or nullptr if the bin contains no child widget. More...

 
void remove ()
 Remove the contained widget. More...

 
void add_label (const Glib::ustring& label, bool mnemonic=false, Align x_align=Align::CENTER, Align y_align=Align::CENTER)
 Add a Label object. More...

 
void add_pixlabel (const std::string& pixfile, const Glib::ustring& label, Align x_align=Align::CENTER, Align y_align=Align::CENTER)
 Add Image and Label objects. More...

 
- Public Member Functions inherited from Gtk::Container
 Container (Container&& src) noexcept
 
Containeroperator= (Container&& src) noexcept
 
 Container (const Container&)=delete
 
Containeroperator= (const Container&)=delete
 
 ~Container () noexcept override
 
GtkContainer* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkContainer* gobj () const
 Provides access to the underlying C GObject. More...

 
void add (Widget& widget)
 Adds widget to container. More...

 
void remove (Widget& widget)
 Removes widget from the container. More...

 
void foreach (const ForeachSlot& slot)
 Operate on contained items. More...

 
void forall (const ForeachSlot& slot)
 Operate on contained items, including internal children. More...

 
std::vector< Widget* > get_children ()
 Returns the container’s non-internal children. More...

 
std::vector< const Widget* > get_children () const
 Returns the container’s non-internal children. More...

 
void set_focus_vadjustment (const Glib::RefPtr< Adjustment >& adjustment)
 Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. More...

 
Glib::RefPtr< Adjustmentget_focus_vadjustment ()
 Retrieves the vertical focus adjustment for the container. More...

 
Glib::RefPtr< const Adjustmentget_focus_vadjustment () const
 Retrieves the vertical focus adjustment for the container. More...

 
void set_focus_hadjustment (const Glib::RefPtr< Adjustment >& adjustment)
 Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. More...

 
Glib::RefPtr< Adjustmentget_focus_hadjustment ()
 Retrieves the horizontal focus adjustment for the container. More...

 
Glib::RefPtr< const Adjustmentget_focus_hadjustment () const
 Retrieves the horizontal focus adjustment for the container. More...

 
GType child_type () const
 Returns the type of the children supported by the container. More...

 
WidgetPath get_path_for_child (const Widget& child) const
 Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child. More...

 
Glib::SignalProxy< void(Widget*)> signal_add ()
 
Glib::SignalProxy< void(Widget*)> signal_remove ()
 
- Public Member Functions inherited from Gtk::Widget
 Widget (Widget&& src) noexcept
 
Widgetoperator= (Widget&& src) noexcept
 
 Widget (const Widget&)=delete
 
Widgetoperator= (const Widget&)=delete
 
 ~Widget () noexcept override
 Destroys the widget. More...

 
GtkWidget* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkWidget* gobj () const
 Provides access to the underlying C GObject. More...

 
void show ()
 Flags a widget to be displayed. More...

 
void hide ()
 Reverses the effects of show(), causing the widget to be hidden (invisible to the user). More...

 
void queue_draw ()
 Schedules this widget to be redrawn in paint phase of the current or the next frame. More...

 
void queue_resize ()
 This function is only for use in widget implementations. More...

 
void queue_allocate ()
 This function is only for use in widget implementations. More...

 
void size_allocate (const Allocation& allocation, int baseline)
 This is a simple form of allocate() that takes the new position of widget as part of allocation. More...

 
SizeRequestMode get_request_mode () const
 Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More...

 
void measure (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const
 Measures widget in the orientation orientation and for the given for_size. More...

 
void get_preferred_size (Requisition& minimum_size, Requisition& natural_size) const
 Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. More...

 
void set_layout_manager (const Glib::RefPtr< LayoutManager >& layout_manager)
 Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget. More...

 
void unset_layout_manager ()
 Undoes the effect of a previous call to set_layout_manager(). More...

 
Glib::RefPtr< LayoutManagerget_layout_manager ()
 Retrieves the layout manager set using set_layout_manager(). More...

 
Glib::RefPtr< const LayoutManagerget_layout_manager () const
 Retrieves the layout manager set using set_layout_manager(). More...

 
void add_accelerator (const Glib::ustring& accel_signal, const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags)
 Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated. More...

 
bool remove_accelerator (const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods)
 Removes an accelerator from widget, previously installed with add_accelerator(). More...

 
void set_accel_path (const Glib::ustring& accel_path, const Glib::RefPtr< AccelGroup >& accel_group)
 Given an accelerator group, accel_group, and an accelerator path, accel_path, sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, widget will be activated. More...

 
bool mnemonic_activate (bool group_cycling)
 Emits the Gtk::Widget::signal_mnemonic_activate() signal. More...

 
bool event (const Glib::RefPtr< const Gdk::Event >& gdk_event)
 Rarely-used function. More...

 
bool activate ()
 For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More...

 
void reparent (Container& new_parent)
 Moves a widget from one Gtk::Container to another, handling reference count issues to avoid destroying the widget. More...

 
void set_can_focus (bool can_focus=true)
 Specifies whether widget can own the input focus. More...

 
bool get_can_focus () const
 Determines whether widget can own the input focus. More...

 
bool has_focus () const
 Determines if the widget has the global input focus. More...

 
bool is_focus () const
 Determines if the widget is the focus widget within its toplevel. More...

 
bool has_visible_focus () const
 Determines if the widget should show a visible indication that it has the global input focus. More...

 
void grab_focus ()
 Causes widget (or one of its descendents) to have the keyboard focus for the Gtk::Window it's inside. More...

 
void set_focus_on_click (bool focus_on_click=true)
 Sets whether the widget should grab focus when it is clicked with the mouse. More...

 
bool get_focus_on_click () const
 Returns whether the widget should grab focus when it is clicked with the mouse. More...

 
void set_can_target (bool can_target=true)
 Sets whether widget can be the target of pointer events. More...

 
bool get_can_target () const
 Queries whether widget can be the target of pointer events. More...

 
bool has_default () const
 Determines whether widget is the current default widget within its toplevel. More...

 
void set_receives_default (bool receives_default=true)
 Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...

 
bool get_receives_default () const
 Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...

 
bool has_grab () const
 Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse). More...

 
bool device_is_shadowed (const Glib::RefPtr< const Gdk::Device >& device)
 Returns true if device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to widget. More...

 
void add_modal_grab ()
 Block events to everything else than this widget and its children. More...

 
void remove_modal_grab ()
 Remove the modal grab of the widget in case it was previously grabbed. More...

 
void set_name (const Glib::ustring& name)
 Widgets can be named, which allows you to refer to them from a CSS file. More...

 
void unset_name ()
 
Glib::ustring get_name () const
 Retrieves the name of a widget. More...

 
void set_state_flags (StateFlags flags, bool clear=true)
 This function is for use in widget implementations. More...

 
void unset_state_flags (StateFlags flags)
 This function is for use in widget implementations. More...

 
StateFlags get_state_flags () const
 Returns the widget state as a flag set. More...

 
void set_sensitive (bool sensitive=true)
 Sets the sensitivity of a widget. More...

 
bool get_sensitive () const
 Returns the widget’s sensitivity (in the sense of returning the value that has been set using set_sensitive()). More...

 
bool is_sensitive () const
 Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive. More...

 
void set_visible (bool visible=true)
 Sets the visibility state of widget. More...

 
bool get_visible () const
 Determines whether the widget is visible. More...

 
bool is_visible () const
 Determines whether the widget and all its parents are marked as visible. More...

 
bool get_has_surface () const
 Determines whether widget has a Gdk::Surface of its own. More...

 
bool get_is_toplevel () const
 Determines whether widget is a toplevel widget. More...

 
bool get_is_drawable () const
 Determines whether widget can be drawn to. More...

 
bool get_realized () const
 Determines whether widget is realized. More...

 
bool get_mapped () const
 Whether the widget is mapped. More...

 
void set_child_visible (bool visible=true)
 Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with show(). More...

 
bool get_child_visible () const
 Gets the value set with set_child_visible(). More...

 
Glib::RefPtr< Gdk::Surfaceget_surface ()
 Returns the widget’s surface if it is realized, nullptr otherwise. More...

 
Glib::RefPtr< const Gdk::Surfaceget_surface () const
 Returns the widget’s surface if it is realized, nullptr otherwise. More...

 
void register_surface (const Glib::RefPtr< Gdk::Surface >& surface)
 Registers a Gdk::Surface with the widget and sets it up so that the widget receives events for it. More...

 
void unregister_surface (const Glib::RefPtr< Gdk::Surface >& surface)
 Unregisters a Gdk::Surface from the widget that was previously set up with register_surface(). More...

 
int get_allocated_width () const
 Returns the width that has currently been allocated to widget. More...

 
int get_allocated_height () const
 Returns the height that has currently been allocated to widget. More...

 
int get_allocated_baseline () const
 Returns the baseline that has currently been allocated to widget. More...

 
Allocation get_allocation () const
 Retrieves the widget's location. More...

 
int get_width () const
 Returns the content width of the widget, as passed to its size-allocate implementation. More...

 
int get_height () const
 Returns the content height of the widget, as passed to its size-allocate implementation. More...

 
Containerget_parent ()
 Returns the parent widget of widget. More...

 
const Containerget_parent () const
 Returns the parent widget of widget. More...

 
Rootget_root ()
 Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More...

 
const Rootget_root () const
 Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More...

 
bool child_focus (DirectionType direction)
 This function is used by custom widget implementations; if you're writing an app, you’d use grab_focus() to move the focus to a particular widget. More...

 
bool keynav_failed (DirectionType direction)
 This function should be called whenever keyboard navigation within a single widget hits a boundary. More...

 
void error_bell ()
 Notifies the user about an input-related error on this widget. More...

 
void set_size_request (int width=-1, int height=-1)
 Sets the minimum size of a widget; that is, the widget’s size request will be at least width by height. More...

 
void get_size_request (int& width, int& height) const
 Gets the size request that was explicitly set for the widget using set_size_request(). More...

 
void set_opacity (double opacity)
 Request the widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. More...

 
double get_opacity () const
 Fetches the requested opacity for this widget. More...

 
void set_overflow (Overflow overflow)
 Sets how widget treats content that is drawn outside the widget's content area. More...

 
Overflow get_overflow () const
 Returns the value set via set_overflow(). More...

 
Containerget_toplevel ()
 This function returns the topmost widget in the container hierarchy widget is a part of. More...

 
const Containerget_toplevel () const
 This function returns the topmost widget in the container hierarchy widget is a part of. More...

 
Widgetget_ancestor (GType widget_type)
 Gets the first ancestor of widget with type widget_type. More...

 
const Widgetget_ancestor (GType widget_type) const
 Gets the first ancestor of widget with type widget_type. More...

 
int get_scale_factor () const
 Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. More...

 
Glib::RefPtr< Gdk::Displayget_display ()
 Get the Gdk::Display for the toplevel window associated with this widget. More...

 
Glib::RefPtr< const Gdk::Displayget_display () const
 Get the Gdk::Display for the toplevel window associated with this widget. More...

 
Glib::RefPtr< Settingsget_settings ()
 Gets the settings object holding the settings used for this widget. More...

 
Glib::RefPtr< Gdk::Clipboardget_clipboard ()
 This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More...

 
Glib::RefPtr< const Gdk::Clipboardget_clipboard () const
 This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More...

 
Glib::RefPtr< Gdk::Clipboardget_primary_clipboard ()
 This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. More...

 
Glib::RefPtr< const Gdk::Clipboardget_primary_clipboard () const
 This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. More...

 
bool get_hexpand () const
 Gets whether the widget would like any available extra horizontal space. More...

 
void set_hexpand (bool expand=true)
 Sets whether the widget would like any available extra horizontal space. More...

 
bool get_hexpand_set () const
 Gets whether set_hexpand() has been used to explicitly set the expand flag on this widget. More...

 
void set_hexpand_set (bool set=true)
 Sets whether the hexpand flag (see get_hexpand()) will be used. More...

 
bool get_vexpand () const
 Gets whether the widget would like any available extra vertical space. More...

 
void set_vexpand (bool expand=true)
 Sets whether the widget would like any available extra vertical space. More...

 
bool get_vexpand_set () const
 Gets whether set_vexpand() has been used to explicitly set the expand flag on this widget. More...

 
void set_vexpand_set (bool set=true)
 Sets whether the vexpand flag (see get_vexpand()) will be used. More...

 
void queue_compute_expand ()
 Mark widget as needing to recompute its expand flags. More...

 
bool compute_expand (Orientation orientation)
 Computes whether a container should give this widget extra space when possible. More...

 
void set_expand (bool expand=true)
 Sets whether the widget would like any available extra space in both directions. More...

 
bool get_support_multidevice () const
 Returns true if widget is multiple pointer aware. More...

 
void set_support_multidevice (bool support_multidevice=true)
 Enables or disables multiple pointer awareness. More...

 
Glib::RefPtr< Atk::Objectget_accessible ()
 Returns the accessible object that describes the widget to an assistive technology. More...

 
Glib::RefPtr< const Atk::Objectget_accessible () const
 Returns the accessible object that describes the widget to an assistive technology. More...

 
Align get_halign () const
 Gets the value of the Gtk::Widget::property_halign() property. More...

 
void set_halign (Align align)
 Sets the horizontal alignment of widget. More...

 
Align get_valign () const
 Gets the value of the Gtk::Widget::property_valign() property. More...

 
void set_valign (Align align)
 Sets the vertical alignment of widget. More...

 
int get_margin_start () const
 Gets the value of the Gtk::Widget::property_margin_start() property. More...

 
void set_margin_start (int margin)
 Sets the start margin of widget. More...

 
int get_margin_end () const
 Gets the value of the Gtk::Widget::property_margin_end() property. More...

 
void set_margin_end (int margin)
 Sets the end margin of widget. More...

 
int get_margin_top () const
 Gets the value of the Gtk::Widget::property_margin_top() property. More...

 
void set_margin_top (int margin)
 Sets the top margin of widget. More...

 
int get_margin_bottom () const
 Gets the value of the Gtk::Widget::property_margin_bottom() property. More...

 
void set_margin_bottom (int margin)
 Sets the bottom margin of widget. More...

 
void set_margin (int margin)
 Set all 4 margins to the same value. More...

 
bool is_ancestor (Widget& ancestor) const
 Determines whether widget is somewhere inside ancestor, possibly with intermediate containers. More...

 
bool translate_coordinates (Widget& dest_widget, int src_x, int src_y, int& dest_x, int& dest_y)
 Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More...

 
bool contains (double x, double y) const
 Tests if the point at ( x, y) is contained in widget. More...

 
Widgetpick (double x, double y, PickFlags flags=PickFlags::DEFAULT)
 Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More...

 
const Widgetpick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const
 Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More...

 
void add_controller (const Glib::RefPtr< EventController >& controller)
 Adds controller to widget so that it will receive events. More...

 
void remove_controller (const Glib::RefPtr< EventController >& controller)
 Removes controller from widget, so that it doesn't process events anymore. More...

 
void reset_style ()
 Updates the style context of widget and all descendants by updating its widget path. More...

 
Glib::RefPtr< Pango::Contextcreate_pango_context ()
 Creates a new Pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. More...

 
Glib::RefPtr< Pango::Contextget_pango_context ()
 Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget. More...

 
void set_font_options (const Cairo::FontOptions& options)
 Sets the #cairo_font_options_t used for Pango rendering in this widget. More...

 
void unset_font_options ()
 Undoes the effect of previous calls to set_font_options(). More...

 
Cairo::FontOptions get_font_options () const
 Returns the #cairo_font_options_t used for Pango rendering. More...

 
Glib::RefPtr< Pango::Layoutcreate_pango_layout (const Glib::ustring& text)
 Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. More...

 
void set_direction (TextDirection dir)
 Sets the reading direction on a particular widget. More...

 
TextDirection get_direction () const
 Gets the reading direction for a particular widget. More...

 
void input_shape_combine_region (const Cairo::RefPtr< const Cairo::Region >& region)
 Sets an input shape for this widget’s GDK surface. More...

 
void set_cursor (const Glib::RefPtr< Gdk::Cursor >& cursor)
 Sets the cursor to be shown when pointer devices point towards widget. More...

 
void set_cursor (const Glib::ustring& name={})
 Sets a named cursor to be shown when pointer devices point towards the widget. More...

 
Glib::RefPtr< Gdk::Cursorget_cursor ()
 Queries the cursor set via set_cursor(). More...

 
Glib::RefPtr< const Gdk::Cursorget_cursor () const
 Queries the cursor set via set_cursor(). More...

 
WidgetPath get_path () const
 Returns the Gtk::WidgetPath representing widget, if the widget is not connected to a toplevel widget, a partial path will be created. More...

 
std::vector< Widget* > list_mnemonic_labels ()
 Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More...

 
std::vector< const Widget* > list_mnemonic_labels () const
 Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More...

 
void add_mnemonic_label (Widget& label)
 Adds a widget to the list of mnemonic labels for this widget. More...

 
void remove_mnemonic_label (Widget& label)
 Removes a widget from the list of mnemonic labels for this widget. More...

 
void drag_get_data (const Glib::RefPtr< Gdk::Drop >& drop, const Glib::ustring& target)
 Gets the data associated with a drag. More...

 
void drag_highlight ()
 Highlights a widget as a currently hovered drop target. More...

 
void drag_unhighlight ()
 Removes a highlight set by gtk_drag_highlight() from a widget. More...

 
void drag_dest_set (DestDefaults flags=DestDefaults(0), Gdk::DragAction actions=Gdk::DragAction(0))
 Sets a widget as a potential drop destination, and adds default behaviors. More...

 
void drag_dest_set (const Glib::RefPtr< Gdk::ContentFormats >& targets, DestDefaults flags=DestDefaults::ALL, Gdk::DragAction actions=Gdk::DragAction::COPY)
 Sets a widget as a potential drop destination, and adds default behaviors. More...

 
void drag_dest_unset ()
 Clears information about a drop destination set with gtk_drag_dest_set(). More...

 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::Drop >& drop, const Glib::RefPtr< Gdk::ContentFormats >& target_list={}) const
 Looks for a match between the supported targets of drop and the target_list, returning the first matching target, otherwise returning an empty string. More...

 
Glib::RefPtr< Gdk::ContentFormatsdrag_dest_get_target_list ()
 Returns the list of targets this widget can accept from drag-and-drop. More...

 
Glib::RefPtr< const Gdk::ContentFormatsdrag_dest_get_target_list () const
 Returns the list of targets this widget can accept from drag-and-drop. More...

 
void drag_dest_set_target_list (const Glib::RefPtr< Gdk::ContentFormats >& target_list)
 Sets the target types that this widget can accept from drag-and-drop. More...

 
void drag_dest_add_text_targets ()
 Add the text targets supported by Gtk::SelectionData to the target list of the drag destination. More...

 
void drag_dest_add_image_targets ()
 Add the image targets supported by Gtk::SelectionData to the target list of the drag destination. More...

 
void drag_dest_add_uri_targets ()
 Add the URI targets supported by Gtk::SelectionData to the target list of the drag destination. More...

 
void drag_dest_set_track_motion (bool track_motion=true)
 Tells the widget to emit Gtk::Widget::signal_drag_motion() and Gtk::Widget::signal_drag_leave() events regardless of the targets and the Gtk::DestDefaults::MOTION flag. More...

 
bool drag_dest_get_track_motion () const
 Returns whether the widget has been configured to always emit Gtk::Widget::signal_drag_motion() signals. More...

 
void drag_source_set (const Glib::RefPtr< Gdk::ContentFormats >& targets, Gdk::ModifierType start_button_mask=Gdk::ModifierType::MODIFIER_MASK, Gdk::DragAction actions=Gdk::DragAction::COPY)
 Sets up a widget so that GTK+ will start a drag operation when the user clicks and drags on the widget. More...

 
void drag_source_unset ()
 Undoes the effects of gtk_drag_source_set(). More...

 
Glib::RefPtr< Gdk::ContentFormatsdrag_source_get_target_list ()
 Gets the list of targets this widget can provide for drag-and-drop. More...

 
Glib::RefPtr< const Gdk::ContentFormatsdrag_source_get_target_list () const
 Gets the list of targets this widget can provide for drag-and-drop. More...

 
void drag_source_set_target_list (const Glib::RefPtr< Gdk::ContentFormats >& target_list)
 Changes the target types that this widget offers for drag-and-drop. More...

 
void drag_source_set_icon (const Glib::ustring& icon_name)
 Sets the icon that will be used for drags from a particular source to a themed icon. More...

 
void drag_source_set_icon (const Glib::RefPtr< Gio::Icon >& icon)
 Sets the icon that will be used for drags from a particular source to icon. More...

 
void drag_source_set_icon (const Glib::RefPtr< Gdk::Paintable >& paintable)
 Sets the icon that will be used for drags from a particular source to paintable. More...

 
void drag_source_add_text_targets ()
 Add the text targets supported by Gtk::SelectionData to the target list of the drag source. More...

 
void drag_source_add_uri_targets ()
 Add the URI targets supported by Gtk::SelectionData to the target list of the drag source. More...

 
void drag_source_add_image_targets ()
 Add the writable image targets supported by Gtk::SelectionData to the target list of the drag source. More...

 
Glib::RefPtr< Gdk::Dragdrag_begin (const Glib::RefPtr< Gdk::Device >& device, const Glib::RefPtr< Gdk::ContentFormats >& targets, Gdk::DragAction actions, int x, int y)
 Initiates a drag on the source side. More...

 
bool drag_check_threshold (int start_x, int start_y, int current_x, int current_y)
 Checks to see if a mouse drag starting at ( start_x, start_y) and ending at ( current_x, current_y) has passed the GTK+ drag threshold, and thus should trigger the beginning of a drag-and-drop operation. More...

 
void queue_resize_no_redraw ()
 This function works like queue_resize(), except that the widget is not invalidated. More...

 
Glib::RefPtr< Gdk::FrameClockget_frame_clock ()
 Obtains the frame clock for a widget. More...

 
Glib::RefPtr< const Gdk::FrameClockget_frame_clock () const
 Obtains the frame clock for a widget. More...

 
void set_parent (Widget& parent)
 This function is useful only when implementing subclasses of Gtk::Widget. More...

 
void unparent ()
 This function is only for use in widget implementations. More...

 
void map ()
 This function is only for use in widget implementations. More...

 
void unmap ()
 This function is only for use in widget implementations. More...

 
void set_tooltip_window (Window& custom_window)
 Replaces the default window used for displaying tooltips with custom_window. More...

 
Windowget_tooltip_window ()
 Returns the Gtk::Window of the current tooltip. More...

 
void trigger_tooltip_query ()
 Triggers a tooltip query on the display where the toplevel of widget is located. More...

 
void set_tooltip_text (const Glib::ustring& text)
 Sets text as the contents of the tooltip. More...

 
Glib::ustring get_tooltip_text () const
 Gets the contents of the tooltip for widget. More...

 
void set_tooltip_markup (const Glib::ustring& markup)
 Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More...

 
Glib::ustring get_tooltip_markup () const
 Gets the contents of the tooltip for widget. More...

 
void set_has_tooltip (bool has_tooltip=TRUE)
 Sets the has-tooltip property on widget to has_tooltip. More...

 
bool get_has_tooltip () const
 Returns the current value of the has-tooltip property. More...

 
bool in_destruction () const
 Returns whether the widget is currently being destroyed. More...

 
Glib::RefPtr< StyleContextget_style_context ()
 Returns the style context associated to widget. More...

 
Glib::RefPtr< Gtk::StyleContextget_style_context () const
 Returns the style context associated to widget. More...

 
Gdk::ModifierType get_modifier_mask (Gdk::ModifierIntent intent)
 Returns the modifier mask the widget’s windowing system backend uses for a particular purpose. More...

 
guint add_tick_callback (const SlotTick& slot)
 Queues an animation frame update and adds a callback to be called before each frame. More...

 
void remove_tick_callback (guint id)
 Removes a tick callback previously registered with add_tick_callback(). More...

 
void insert_action_group (const Glib::ustring& name, const Glib::RefPtr< Gio::ActionGroup >& group)
 Inserts group into widget. More...

 
void remove_action_group (const Glib::ustring& name)
 Removes a group from the widget. More...

 
Glib::RefPtr< Gio::ActionGroupget_action_group (const Glib::ustring& prefix)
 Retrieves the Gio::ActionGroup that was registered using prefix. More...

 
Glib::RefPtr< const Gio::ActionGroupget_action_group (const Glib::ustring& prefix) const
 Retrieves the Gio::ActionGroup that was registered using prefix. More...

 
std::vector< Glib::ustringlist_action_prefixes () const
 Retrieves a nullptr-terminated array of strings containing the prefixes of Gio::ActionGroup's available to widget. More...

 
void activate_action (const Glib::ustring& name, const Glib::VariantBase& parameter)
 Looks up the action in the action groups associated with widget and its ancestors, and activates it. More...

 
void activate_default ()
 Activate the default.activate action from widget. More...

 
void set_font_map (const Glib::RefPtr< Pango::FontMap >& font_map)
 Sets the font map to use for Pango rendering. More...

 
Glib::RefPtr< Pango::FontMapget_font_map ()
 Gets the font map that has been set with set_font_map(). More...

 
Glib::RefPtr< const Pango::FontMapget_font_map () const
 Gets the font map that has been set with set_font_map(). More...

 
Widgetget_first_child ()
 
const Widgetget_first_child () const
 
Widgetget_last_child ()
 
const Widgetget_last_child () const
 
Widgetget_next_sibling ()
 
const Widgetget_next_sibling () const
 
Widgetget_prev_sibling ()
 
const Widgetget_prev_sibling () const
 
Glib::RefPtr< Gio::ListModelobserve_children ()
 Returns a ListModel to track the children of widget. More...

 
Glib::RefPtr< const Gio::ListModelobserve_children () const
 Returns a ListModel to track the children of widget. More...

 
Glib::RefPtr< Gio::ListModelobserve_controllers ()
 Returns a ListModel to track the Gtk::EventControllers of widget. More...

 
Glib::RefPtr< const Gio::ListModelobserve_controllers () const
 Returns a ListModel to track the Gtk::EventControllers of widget. More...

 
void insert_after (Widget& parent, const Widget& previous_sibling)
 Inserts the Widget into the child widget list of parent after previous_sibling. More...

 
void insert_before (Widget& parent, const Widget& next_sibling)
 Inserts the Widget into the child widget list of parent before next_sibling. More...

 
void insert_at_start (Widget& parent)
 Inserts the Widget at the beginning of the child widget list of parent. More...

 
void insert_at_end (Widget& parent)
 Inserts the Widget at the end of the child widget list of parent. More...

 
void snapshot_child (Widget& child, const Glib::RefPtr< Gtk::Snapshot >& snapshot)
 When a widget receives a call to the snapshot function, it must send synthetic Gtk::Widget::signal_snapshot() calls to all children. More...

 
Glib::SignalProxy< void()> signal_show ()
 
Glib::SignalProxy< void()> signal_hide ()
 
Glib::SignalProxy< void()> signal_map ()
 Emitted on mapping of a widget to the screen. More...

 
Glib::SignalProxy< void()> signal_unmap ()
 
Glib::SignalProxy< void()> signal_realize ()
 Emitted on realization of a widget. More...

 
Glib::SignalProxy< void()> signal_unrealize ()
 
Glib::SignalProxy< void(int, int, int)> signal_size_allocate ()
 
Glib::SignalProxy< void(Gtk::StateFlags)> signal_state_flags_changed ()
 
Glib::SignalProxy< void()> signal_style_updated ()
 
Glib::SignalProxy< void(TextDirection)> signal_direction_changed ()
 
Glib::SignalProxy< void(bool)> signal_grab_notify ()
 
Glib::SignalProxy< bool(bool)> signal_mnemonic_activate ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drag >&)> signal_drag_begin ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drag >&)> signal_drag_end ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drag >&, SelectionData&)> signal_drag_data_get ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drag >&)> signal_drag_data_delete ()
 
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::Drag >&, DragResult)> signal_drag_failed ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drop >&)> signal_drag_leave ()
 
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::Drop >&, int, int)> signal_drag_motion ()
 
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::Drop >&, int, int)> signal_drag_drop ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drop >&, const SelectionData&)> signal_drag_data_received ()
 
Glib::SignalProxy< void()> signal_accel_closures_changed ()
 
Glib::SignalProxy< bool()> signal_popup_menu ()
 
Glib::SignalProxy< bool(int, int, bool, const Glib::RefPtr< Tooltip >&)> signal_query_tooltip ()
 
Glib::PropertyProxy< Glib::ustringproperty_name ()
 The name of the widget. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_name () const
 The name of the widget. More...

 
Glib::PropertyProxy_ReadOnly< Container* > property_parent () const
 The parent widget of this widget. More...

 
Glib::PropertyProxy_ReadOnly< Root* > property_root () const
 The Gtk::Root widget of the widget tree containing this widget or nullptr if the widget is not contained in a root widget. More...

 
Glib::PropertyProxy< int > property_width_request ()
 Override for width request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy_ReadOnly< int > property_width_request () const
 Override for width request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy< int > property_height_request ()
 Override for height request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy_ReadOnly< int > property_height_request () const
 Override for height request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy< bool > property_visible ()
 Whether the widget is visible. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 Whether the widget is visible. More...

 
Glib::PropertyProxy< bool > property_sensitive ()
 Whether the widget responds to input. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 Whether the widget responds to input. More...

 
Glib::PropertyProxy< bool > property_can_focus ()
 Whether the widget can accept the input focus. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_can_focus () const
 Whether the widget can accept the input focus. More...

 
Glib::PropertyProxy< bool > property_has_focus ()
 Whether the widget has the input focus. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_has_focus () const
 Whether the widget has the input focus. More...

 
Glib::PropertyProxy< bool > property_is_focus ()
 Whether the widget is the focus widget within the toplevel. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_is_focus () const
 Whether the widget is the focus widget within the toplevel. More...

 
Glib::PropertyProxy< bool > property_can_target ()
 Whether the widget can receive pointer events. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_can_target () const
 Whether the widget can receive pointer events. More...

 
Glib::PropertyProxy< bool > property_focus_on_click ()
 Whether the widget should grab focus when it is clicked with the mouse. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_focus_on_click () const
 Whether the widget should grab focus when it is clicked with the mouse. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_has_default () const
 Whether the widget is the default widget. More...

 
Glib::PropertyProxy< bool > property_receives_default ()
 If true, the widget will receive the default action when it is focused. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_receives_default () const
 If true, the widget will receive the default action when it is focused. More...

 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Cursor > > property_cursor ()
 The cursor used by widget. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Cursor > > property_cursor () const
 The cursor used by widget. More...

 
Glib::PropertyProxy< bool > property_has_tooltip ()
 Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_has_tooltip () const
 Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More...

 
Glib::PropertyProxy< Glib::ustringproperty_tooltip_markup ()
 Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_tooltip_markup () const
 Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More...

 
Glib::PropertyProxy< Glib::ustringproperty_tooltip_text ()
 Sets the text of tooltip to be the given string. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_tooltip_text () const
 Sets the text of tooltip to be the given string. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Surface > > property_surface () const
 The widget's surface if it is realized, nullptr otherwise. More...

 
Glib::PropertyProxy< Alignproperty_halign ()
 How to distribute horizontal space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy_ReadOnly< Alignproperty_halign () const
 How to distribute horizontal space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy< Alignproperty_valign ()
 How to distribute vertical space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy_ReadOnly< Alignproperty_valign () const
 How to distribute vertical space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy< int > property_margin_start ()
 Margin on start of widget, horizontally. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_start () const
 Margin on start of widget, horizontally. More...

 
Glib::PropertyProxy< int > property_margin_end ()
 Margin on end of widget, horizontally. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_end () const
 Margin on end of widget, horizontally. More...

 
Glib::PropertyProxy< int > property_margin_top ()
 Margin on top side of widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_top () const
 Margin on top side of widget. More...

 
Glib::PropertyProxy< int > property_margin_bottom ()
 Margin on bottom side of widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_bottom () const
 Margin on bottom side of widget. More...

 
Glib::PropertyProxy< int > property_margin ()
 Sets all four sides' margin at once. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin () const
 Sets all four sides' margin at once. More...

 
Glib::PropertyProxy< bool > property_hexpand ()
 Whether to expand horizontally. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand () const
 Whether to expand horizontally. More...

 
Glib::PropertyProxy< bool > property_hexpand_set ()
 Whether to use the Gtk::Widget::property_hexpand() property. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand_set () const
 Whether to use the Gtk::Widget::property_hexpand() property. More...

 
Glib::PropertyProxy< bool > property_vexpand ()
 Whether to expand vertically. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand () const
 Whether to expand vertically. More...

 
Glib::PropertyProxy< bool > property_vexpand_set ()
 Whether to use the Gtk::Widget::property_vexpand() property. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand_set () const
 Whether to use the Gtk::Widget::property_vexpand() property. More...

 
Glib::PropertyProxy< bool > property_expand ()
 Whether to expand in both directions. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_expand () const
 Whether to expand in both directions. More...

 
Glib::PropertyProxy< double > property_opacity ()
 The requested opacity of the widget. More...

 
Glib::PropertyProxy_ReadOnly< double > property_opacity () const
 The requested opacity of the widget. More...

 
Glib::PropertyProxy< Overflowproperty_overflow ()
 How content outside the widget's content area is treated. More...

 
Glib::PropertyProxy_ReadOnly< Overflowproperty_overflow () const
 How content outside the widget's content area is treated. More...

 
Glib::PropertyProxy_ReadOnly< int > property_scale_factor () const
 The scale factor of the widget. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_css_name () const
 The name of this widget in the CSS tree. More...

 
Glib::PropertyProxy< Glib::RefPtr< LayoutManager > > property_layout_manager ()
 The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< LayoutManager > > property_layout_manager () const
 The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More...

 
- Public Member Functions inherited from Gtk::Object
 Object (Object&& src) noexcept
 
Objectoperator= (Object&& src) noexcept
 
 ~Object () noexcept override
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
void * get_data (const QueryQuark &key)
 
void set_data (const Quark &key, void *data)
 
void set_data (const Quark &key, void *data, DestroyNotify notify)
 
void remove_data (const QueryQuark &quark)
 
void * steal_data (const QueryQuark &quark)
 
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (const ObjectBase &)=delete
 
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
 
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
 
void set_property (const Glib::ustring &property_name, const PropertyType &value)
 
void get_property (const Glib::ustring &property_name, PropertyType &value) const
 
PropertyType get_property (const Glib::ustring &property_name) const
 
sigc::connection connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)
 
sigc::connection connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot)
 
void freeze_notify ()
 
void thaw_notify ()
 
virtual void reference () const
 
virtual void unreference () const
 
GObject * gobj ()
 
const GObject * gobj () const
 
GObject * gobj_copy () const
 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src) noexcept
 
 ~trackable ()
 
void add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (notifiable *data) const
 
- Public Member Functions inherited from Gtk::Buildable
 Buildable (Buildable&& src) noexcept
 
Buildableoperator= (Buildable&& src) noexcept
 
 ~Buildable () noexcept override
 
GtkBuildable* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkBuildable* gobj () const
 Provides access to the underlying C GObject. More...

 
void set_name (const Glib::ustring& name)
 Sets the name of the buildable object. More...

 
Glib::ustring get_name () const
 Gets the name of the buildable object. More...

 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 
 Interface (Interface &&src) noexcept
 
Interfaceoperator= (Interface &&src) noexcept
 
 Interface (const Glib::Interface_Class &interface_class)
 
 Interface (GObject *castitem)
 
 ~Interface () noexcept override
 
 Interface (const Interface &)=delete
 
Interfaceoperator= (const Interface &)=delete
 
GObject * gobj ()
 
const GObject * gobj () const
 
- Public Member Functions inherited from Atk::Implementor
 Implementor (Implementor &&src) noexcept
 
Implementoroperator= (Implementor &&src) noexcept
 
 ~Implementor () noexcept override
 
AtkImplementor * gobj ()
 
const AtkImplementor * gobj () const
 
Glib::RefPtr< Atk::Implementorwrap (AtkImplementor *object, bool take_copy=false)
 
- Public Member Functions inherited from Gtk::Root
 Root (Root&& src) noexcept
 
Rootoperator= (Root&& src) noexcept
 
 ~Root () noexcept override
 
GtkRoot* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkRoot* gobj () const
 Provides access to the underlying C GObject. More...

 
void set_focus (Widget& focus)
 If focus is not the current focus widget, and is focusable, sets it as the focus widget for the root. More...

 
void unset_focus ()
 Unsets the focus widget for the root. More...

 
Widgetget_focus ()
 Retrieves the current focused widget within the root. More...

 
const Widgetget_focus () const
 Retrieves the current focused widget within the root. More...

 
Glib::PropertyProxy< Widget* > property_focus_widget ()
 The focus widget. More...

 
Glib::PropertyProxy_ReadOnly< Widget* > property_focus_widget () const
 The focus widget. More...

 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gtk::Dialog
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gtk::Window
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static void set_default_icon_name (const Glib::ustring& name)
 Sets an icon to be used as fallback for windows that haven't had gtk_window_set_icon_list() called on them from a named themed icon, see set_icon_name(). More...

 
static Glib::ustring get_default_icon_name ()
 Returns the fallback icon name for windows that has been set with set_default_icon_name(). More...

 
static void set_auto_startup_notification (bool setting=true)
 By default, after showing the first Gtk::Window, GTK+ calls gdk_notify_startup_complete(). More...

 
static Glib::RefPtr< Gio::ListModelget_toplevels ()
 Returns a list of all existing toplevel windows. More...

 
static std::vector< Window* > list_toplevels ()
 Returns a list of all existing toplevel windows. More...

 
- Static Public Member Functions inherited from Gtk::Bin
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gtk::Container
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gtk::Widget
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Widgetget_current_modal_grab ()
 Retrieve the widget which is currently grabbing all events. More...

 
static void set_default_direction (TextDirection dir)
 Sets the default reading direction for widgets where the direction has not been explicitly set by set_direction(). More...

 
static TextDirection get_default_direction ()
 Obtains the current default reading direction. More...

 
- Static Public Member Functions inherited from Gtk::Buildable
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Atk::Implementor
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 
- Static Public Member Functions inherited from Gtk::Root
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Widgetget_for_surface (const Glib::RefPtr< const Gdk::Surface >& surface)
 Finds the GtkRoot associated with the surface. More...

 

Protected Member Functions

virtual bool on_activate_link (const std::string& uri)
 This is a default handler for the signal signal_activate_link(). More...

 
- Protected Member Functions inherited from Gtk::Dialog
virtual void on_response (int response_id)
 This is a default handler for the signal signal_response(). More...

 
- Protected Member Functions inherited from Gtk::Window
void destroy_ ()
 
virtual void on_keys_changed ()
 This is a default handler for the signal signal_keys_changed(). More...

 
virtual bool on_close_request ()
 This is a default handler for the signal signal_close_request(). More...

 
- Protected Member Functions inherited from Gtk::Bin
 Bin ()
 This constructor is protected because only derived classes should be instantiated. More...

 
- Protected Member Functions inherited from Gtk::Container
 Container ()
 
virtual GType child_type_vfunc () const
 Implements child_type(). More...

 
virtual void forall_vfunc (const ForeachSlot& slot)
 Invokes a callback on all non-internal children of the container. More...

 
virtual void set_focus_child_vfunc (Widget* child)
 Sets the focused child of container. More...

 
virtual WidgetPath get_path_for_child_vfunc (const Widget* child) const
 Returns a widget path representing all the widget hierarchy from the toplevel down to and including child. More...

 
virtual void on_add (Widget* widget)
 This is a default handler for the signal signal_add(). More...

 
virtual void on_remove (Widget* widget)
 This is a default handler for the signal signal_remove(). More...

 
- Protected Member Functions inherited from Gtk::Widget
virtual void root_vfunc ()
 
virtual void unroot_vfunc ()
 
virtual SizeRequestMode get_request_mode_vfunc () const
 
virtual void measure_vfunc (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const
 
virtual void grab_focus_vfunc ()
 
virtual Glib::RefPtr< Atk::Objectget_accessible_vfunc ()
 
virtual void compute_expand_vfunc (bool& hexpand_p, bool& vexpand_p)
 
virtual bool contains_vfunc (double x, double y) const
 
virtual void snapshot_vfunc (const Glib::RefPtr< Gtk::Snapshot >& snapshot)
 
 Widget ()
 
void realize ()
 Creates the GDK (windowing system) resources associated with a widget. More...

 
void unrealize ()
 This function is only useful in widget implementations. More...

 
void set_has_surface (bool has_surface=true)
 Specifies whether widget has a Gdk::Surface of its own. More...

 
void set_surface (const Glib::RefPtr< Gdk::Surface >& surface)
 Sets a widget's surface. More...

 
void realize_if_needed ()
 
void set_focus_child (Widget& child)
 Set child as the current focus child of widget. More...

 
void unset_focus_child ()
 Unsets the focus child of the widget. More...

 
Widgetget_focus_child ()
 Returns the current focus child of widget. More...

 
const Widgetget_focus_child () const
 Returns the current focus child of widget. More...

 
virtual void on_show ()
 This is a default handler for the signal signal_show(). More...

 
virtual void on_hide ()
 This is a default handler for the signal signal_hide(). More...

 
virtual void on_map ()
 This is a default handler for the signal signal_map(). More...

 
virtual void on_unmap ()
 This is a default handler for the signal signal_unmap(). More...

 
virtual void on_realize ()
 This is a default handler for the signal signal_realize(). More...

 
virtual void on_unrealize ()
 This is a default handler for the signal signal_unrealize(). More...

 
virtual void on_size_allocate (int width, int height, int baseline)
 This is a default handler for the signal signal_size_allocate(). More...

 
virtual void on_state_flags_changed (Gtk::StateFlags previous_state_flags)
 This is a default handler for the signal signal_state_flags_changed(). More...

 
virtual void on_style_updated ()
 This is a default handler for the signal signal_style_updated(). More...

 
virtual void on_direction_changed (TextDirection direction)
 This is a default handler for the signal signal_direction_changed(). More...

 
virtual void on_grab_notify (bool was_grabbed)
 This is a default handler for the signal signal_grab_notify(). More...

 
virtual bool on_mnemonic_activate (bool group_cycling)
 This is a default handler for the signal signal_mnemonic_activate(). More...

 
virtual void on_drag_begin (const Glib::RefPtr< Gdk::Drag >& drag)
 This is a default handler for the signal signal_drag_begin(). More...

 
virtual void on_drag_end (const Glib::RefPtr< Gdk::Drag >& drag)
 This is a default handler for the signal signal_drag_end(). More...

 
virtual void on_drag_data_get (const Glib::RefPtr< Gdk::Drag >& drag, SelectionData& selection_data)
 This is a default handler for the signal signal_drag_data_get(). More...

 
virtual void on_drag_data_delete (const Glib::RefPtr< Gdk::Drag >& drag)
 This is a default handler for the signal signal_drag_data_delete(). More...

 
virtual bool on_drag_failed (const Glib::RefPtr< Gdk::Drag >& drag, DragResult result)
 This is a default handler for the signal signal_drag_failed(). More...

 
virtual void on_drag_leave (const Glib::RefPtr< Gdk::Drop >& drop)
 This is a default handler for the signal signal_drag_leave(). More...

 
virtual bool on_drag_motion (const Glib::RefPtr< Gdk::Drop >& drop, int x, int y)
 This is a default handler for the signal signal_drag_motion(). More...

 
virtual bool on_drag_drop (const Glib::RefPtr< Gdk::Drop >& drop, int x, int y)
 This is a default handler for the signal signal_drag_drop(). More...

 
virtual void on_drag_data_received (const Glib::RefPtr< Gdk::Drop >& drop, const SelectionData& selection_data)
 This is a default handler for the signal signal_drag_data_received(). More...

 
virtual bool on_popup_menu ()
 This is a default handler for the signal signal_popup_menu(). More...

 
virtual bool on_query_tooltip (int x, int y, bool keyboard_tooltip, const Glib::RefPtr< Tooltip >& tooltip)
 This is a default handler for the signal signal_query_tooltip(). More...

 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexcept override
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 
 ObjectBase (const char *custom_type_name)
 
 ObjectBase (const std::type_info &custom_type_info)
 
 ObjectBase (ObjectBase &&src) noexcept
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 
- Protected Member Functions inherited from Gtk::Buildable
 Buildable ()
 You should derive from this class to use it. More...

 
- Protected Member Functions inherited from Atk::Implementor
 Implementor ()
 
virtual Glib::RefPtr< Objectref_accessibile_vfunc ()
 
- Protected Member Functions inherited from Gtk::Root
 Root ()
 You should derive from this class to use it. More...

 
virtual Glib::RefPtr< Gdk::Displayget_display_vfunc ()
 
virtual void get_surface_transform_vfunc (int& x, int& y)
 

Related Functions

(Note that these are not member functions.)

Gtk::AboutDialogwrap (GtkAboutDialog* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Additional Inherited Members

- Public Types inherited from Gtk::Container
using ForeachSlot = sigc::slot< void(Widget&)>
 A slot to invoke with each child iterated over by foreach() or forall(). More...

 
- Public Types inherited from Gtk::Widget
using SlotTick = sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock >&)>
 Callback type for adding a function to update animations. More...

 
- Public Types inherited from Glib::Object
typedef void(*)(gpointer data DestroyNotify)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 
- Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify func_destroy_notify
 

Detailed Description

The AboutDialog offers a simple way to display information about a program like its logo, name, copyright, website and license.

It is also possible to give credits to the authors, documenters, translators and artists who have worked on the program. An about dialog is typically opened when the user selects the About option from the Help menu. All parts of the dialog are optional.

About dialogs often contain links and email addresses. Gtk::AboutDialog displays these as clickable links. By default, it calls gtk_show_uri() when a user clicks one. The behaviour can be overridden with the activate_link signal. Email addresses in the authors, documenters and artists properties are recognized by looking for <user@host>, URLs are recognized by looking for http://url, with the URL extending to the next space, tab or line break.

An AboutDialog looks like this:

aboutdialog1.png

Constructor & Destructor Documentation

Gtk::AboutDialog::AboutDialog ( AboutDialog&&  src)
noexcept
Gtk::AboutDialog::AboutDialog ( const AboutDialog )
delete
Gtk::AboutDialog::~AboutDialog ( )
overridenoexcept
Gtk::AboutDialog::AboutDialog ( )
Gtk::AboutDialog::AboutDialog ( bool  use_header_bar)
explicit

Constructor.

Parameters
use_header_bartrue if the dialog shall use a HeaderBar for action buttons instead of the action-area.
Since gtkmm 3.24:

Member Function Documentation

void Gtk::AboutDialog::add_credit_section ( const Glib::ustring section_name,
const std::vector< Glib::ustring > &  people 
)

Creates a new section in the Credits page.

Parameters
section_nameThe name of the section.
peopleThe people who belong to that section.
std::vector<Glib::ustring> Gtk::AboutDialog::get_artists ( ) const

Returns the string which are displayed in the artists tab of the secondary credits dialog.

Returns
A nullptr-terminated string array containing the artists. The array is owned by the about dialog and must not be modified.
std::vector<Glib::ustring> Gtk::AboutDialog::get_authors ( ) const

Returns the string which are displayed in the authors tab of the secondary credits dialog.

Returns
A nullptr-terminated string array containing the authors. The array is owned by the about dialog and must not be modified.
Glib::ustring Gtk::AboutDialog::get_comments ( ) const

Returns the comments string.

Returns
The comments. The string is owned by the about dialog and must not be modified.
Glib::ustring Gtk::AboutDialog::get_copyright ( ) const

Returns the copyright string.

Returns
The copyright string. The string is owned by the about dialog and must not be modified.
std::vector<Glib::ustring> Gtk::AboutDialog::get_documenters ( ) const

Returns the string which are displayed in the documenters tab of the secondary credits dialog.

Returns
A nullptr-terminated string array containing the documenters. The array is owned by the about dialog and must not be modified.
Glib::ustring Gtk::AboutDialog::get_license ( ) const

Returns the license information.

Returns
The license information. The string is owned by the about dialog and must not be modified.
License Gtk::AboutDialog::get_license_type ( ) const

Retrieves the license set using set_license_type()

Returns
A Gtk::License value.
Glib::RefPtr<Gdk::Paintable> Gtk::AboutDialog::get_logo ( )

Returns the paintable displayed as logo in the about dialog.

Returns
The paintable displayed as logo. The paintable is owned by the about dialog. If you want to keep a reference to it, you have to call Glib::object_ref() on it.
Glib::RefPtr<const Gdk::Paintable> Gtk::AboutDialog::get_logo ( ) const

Returns the paintable displayed as logo in the about dialog.

Returns
The paintable displayed as logo. The paintable is owned by the about dialog. If you want to keep a reference to it, you have to call Glib::object_ref() on it.
Glib::ustring Gtk::AboutDialog::get_logo_icon_name ( ) const

Returns the icon name displayed as logo in the about dialog.

Returns
The icon name displayed as logo. The string is owned by the dialog. If you want to keep a reference to it, you have to call Glib::strdup() on it.
Glib::ustring Gtk::AboutDialog::get_program_name ( ) const

Returns the program name displayed in the about dialog.

Returns
The program name.
Glib::ustring Gtk::AboutDialog::get_system_information ( ) const

Returns the system information that is shown in the about dialog.

Returns
The system information.
Glib::ustring Gtk::AboutDialog::get_translator_credits ( ) const

Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog.

Returns
The translator credits string. The string is owned by the about dialog and must not be modified.
static GType Gtk::AboutDialog::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

Glib::ustring Gtk::AboutDialog::get_version ( ) const

Returns the version string.

Returns
The version string. The string is owned by the about dialog and must not be modified.
Glib::ustring Gtk::AboutDialog::get_website ( ) const

Returns the website URL.

Returns
The website URL. The string is owned by the about dialog and must not be modified.
Glib::ustring Gtk::AboutDialog::get_website_label ( ) const

Returns the label used for the website link.

Returns
The label used for the website link.
bool Gtk::AboutDialog::get_wrap_license ( ) const

Returns whether the license text in about is automatically wrapped.

Returns
true if the license text is wrapped.
GtkAboutDialog* Gtk::AboutDialog::gobj ( )
inline

Provides access to the underlying C GObject.

const GtkAboutDialog* Gtk::AboutDialog::gobj ( ) const
inline

Provides access to the underlying C GObject.

virtual bool Gtk::AboutDialog::on_activate_link ( const std::string uri)
protectedvirtual

This is a default handler for the signal signal_activate_link().

AboutDialog& Gtk::AboutDialog::operator= ( AboutDialog&&  src)
noexcept
AboutDialog& Gtk::AboutDialog::operator= ( const AboutDialog )
delete
Glib::PropertyProxy< std::vector<Glib::ustring> > Gtk::AboutDialog::property_artists ( )

The people who contributed artwork to the program, as a nullptr-terminated array of strings.

Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< std::vector<Glib::ustring> > Gtk::AboutDialog::property_artists ( ) const

The people who contributed artwork to the program, as a nullptr-terminated array of strings.

Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< std::vector<Glib::ustring> > Gtk::AboutDialog::property_authors ( )

The authors of the program, as a nullptr-terminated array of strings.

Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< std::vector<Glib::ustring> > Gtk::AboutDialog::property_authors ( ) const

The authors of the program, as a nullptr-terminated array of strings.

Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::AboutDialog::property_comments ( )

Comments about the program.

This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features.

Default value: ""

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::AboutDialog::property_comments ( ) const

Comments about the program.

This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features.

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::AboutDialog::property_copyright ( )

Copyright information for the program.

Default value: ""

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::AboutDialog::property_copyright ( ) const

Copyright information for the program.

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< std::vector<Glib::ustring> > Gtk::AboutDialog::property_documenters ( )

The people documenting the program, as a nullptr-terminated array of strings.

Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< std::vector<Glib::ustring> > Gtk::AboutDialog::property_documenters ( ) const

The people documenting the program, as a nullptr-terminated array of strings.

Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::AboutDialog::property_license ( )

The license of the program.

This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only wrapped in the text view if the "wrap-license" property is set to true; otherwise the text itself must contain the intended linebreaks. When setting this property to a non-nullptr value, the Gtk::AboutDialog::property_license_type() property is set to Gtk::License::CUSTOM as a side effect.

The text may contain links in this format http://www.some.place/ and email references in the form <mail-to some.body>, and these will be converted into clickable links.

Default value: ""

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::AboutDialog::property_license ( ) const

The license of the program.

This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only wrapped in the text view if the "wrap-license" property is set to true; otherwise the text itself must contain the intended linebreaks. When setting this property to a non-nullptr value, the Gtk::AboutDialog::property_license_type() property is set to Gtk::License::CUSTOM as a side effect.

The text may contain links in this format http://www.some.place/ and email references in the form <mail-to some.body>, and these will be converted into clickable links.

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< License > Gtk::AboutDialog::property_license_type ( )

The license of the program, as a value of the Gtk::License enumeration.

The Gtk::AboutDialog will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license text.

If Gtk::License::UNKNOWN is used, the link used will be the same specified in the Gtk::AboutDialog::property_website() property.

If Gtk::License::CUSTOM is used, the current contents of the Gtk::AboutDialog::property_license() property are used.

For any other Gtk::License value, the contents of the Gtk::AboutDialog::property_license() property are also set by this property as a side effect.

Default value: Gtk::License::UNKNOWN

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< License > Gtk::AboutDialog::property_license_type ( ) const

The license of the program, as a value of the Gtk::License enumeration.

The Gtk::AboutDialog will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license text.

If Gtk::License::UNKNOWN is used, the link used will be the same specified in the Gtk::AboutDialog::property_website() property.

If Gtk::License::CUSTOM is used, the current contents of the Gtk::AboutDialog::property_license() property are used.

For any other Gtk::License value, the contents of the Gtk::AboutDialog::property_license() property are also set by this property as a side effect.

Default value: Gtk::License::UNKNOWN

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::RefPtr<Gdk::Paintable> > Gtk::AboutDialog::property_logo ( )

A logo for the about box.

If it is nullptr, the default window icon set with gtk_window_set_default_icon() will be used.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Paintable> > Gtk::AboutDialog::property_logo ( ) const

A logo for the about box.

If it is nullptr, the default window icon set with gtk_window_set_default_icon() will be used.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::AboutDialog::property_logo_icon_name ( )

A named icon to use as the logo for the about box.

This property overrides the Gtk::AboutDialog::property_logo() property.

Default value: "image-missing"

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::AboutDialog::property_logo_icon_name ( ) const

A named icon to use as the logo for the about box.

This property overrides the Gtk::AboutDialog::property_logo() property.

Default value: "image-missing"

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::AboutDialog::property_program_name ( )

The name of the program.

If this is not set, it defaults to Glib::get_application_name().

Default value: ""

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::AboutDialog::property_program_name ( ) const

The name of the program.

If this is not set, it defaults to Glib::get_application_name().

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::AboutDialog::property_system_information ( )

Information about the system on which the program is running.

This is displayed in a separate tab, therefore it is fine to use a long multi-paragraph text. Note that the text should contain the intended linebreaks.

The text may contain links in this format http://www.some.place/ and email references in the form <mail-to some.body>, and these will be converted into clickable links.

Since gtkmm 3.92:

Default value: ""

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::AboutDialog::property_system_information ( ) const

Information about the system on which the program is running.

This is displayed in a separate tab, therefore it is fine to use a long multi-paragraph text. Note that the text should contain the intended linebreaks.

The text may contain links in this format http://www.some.place/ and email references in the form <mail-to some.body>, and these will be converted into clickable links.

Since gtkmm 3.92:

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< std::vector<Glib::ustring> > Gtk::AboutDialog::property_translator_credits ( )

Credits to the translators.

This string should be marked as translatable. The string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Default value: ""

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< std::vector<Glib::ustring> > Gtk::AboutDialog::property_translator_credits ( ) const

Credits to the translators.

This string should be marked as translatable. The string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::AboutDialog::property_version ( )

The version of the program.

Default value: ""

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::AboutDialog::property_version ( ) const

The version of the program.

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::AboutDialog::property_website ( )

The URL for the link to the website of the program.

This should be a string starting with "http://.

Default value: ""

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::AboutDialog::property_website ( ) const

The URL for the link to the website of the program.

This should be a string starting with "http://.

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::AboutDialog::property_website_label ( )

The label for the link to the website of the program.

Default value: ""

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::AboutDialog::property_website_label ( ) const

The label for the link to the website of the program.

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::AboutDialog::property_wrap_license ( )

Whether to wrap the text in the license dialog.

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::AboutDialog::property_wrap_license ( ) const

Whether to wrap the text in the license dialog.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::AboutDialog::set_artists ( const std::vector< Glib::ustring > &  artists)

Sets the strings which are displayed in the artists tab of the secondary credits dialog.

Parameters
artistsA nullptr-terminated array of strings.
void Gtk::AboutDialog::set_authors ( const std::vector< Glib::ustring > &  authors) const

Sets the strings which are displayed in the authors tab of the secondary credits dialog.

Parameters
authorsA nullptr-terminated array of strings.
void Gtk::AboutDialog::set_comments ( const Glib::ustring comments)

Sets the comments string to display in the about dialog.

This should be a short string of one or two lines.

Parameters
commentsA comments string.
void Gtk::AboutDialog::set_copyright ( const Glib::ustring copyright)

Sets the copyright string to display in the about dialog.

This should be a short string of one or two lines.

Parameters
copyrightThe copyright string.
void Gtk::AboutDialog::set_documenters ( const std::vector< Glib::ustring > &  documenters)

Sets the strings which are displayed in the documenters tab of the credits dialog.

Parameters
documentersA nullptr-terminated array of strings.
void Gtk::AboutDialog::set_license ( const Glib::ustring license)

Sets the license information to be displayed in the secondary license dialog.

If license is an empty string, the license button is hidden.

Since gtkmm 2.6:
Parameters
licenseThe license information.
void Gtk::AboutDialog::set_license_type ( License  license_type)

Sets the license of the application showing the about dialog from a list of known licenses.

This function overrides the license set using set_license().

Parameters
license_typeThe type of license.
void Gtk::AboutDialog::set_logo ( const Glib::RefPtr< const Gdk::Paintable >&  logo)

Sets the surface to be displayed as logo in the about dialog.

If it is nullptr, the default window icon set with gtk_window_set_default_icon() will be used.

Parameters
logoA Gdk::Paintable, or nullptr.
void Gtk::AboutDialog::set_logo_default ( )

Sets the surface to be displayed as logo in the about dialog.

The logo is set to the default window icon set with Gtk::Window::set_default_icon() or Gtk::Window::set_default_icon_list().

Since gtkmm 3.4:
void Gtk::AboutDialog::set_logo_icon_name ( const Glib::ustring icon_name)

Sets the surface to be displayed as logo in the about dialog.

If it is nullptr, the default window icon set with gtk_window_set_default_icon() will be used.

Parameters
icon_nameAn icon name, or nullptr.
void Gtk::AboutDialog::set_program_name ( const Glib::ustring name)

Sets the name to display in the about dialog.

If this is not set, it defaults to Glib::get_application_name().

Parameters
nameThe program name.
void Gtk::AboutDialog::set_system_information ( const Glib::ustring system_information)

Sets the system information to be displayed in the about dialog.

If system_information is an empty string, the system information tab is hidden.

See Gtk::Aboutdialog::property_system_information().

Since gtkmm 3.92:
Parameters
system_informationSystem information.
void Gtk::AboutDialog::set_translator_credits ( const Glib::ustring translator_credits)

Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog.

The intended use for this string is to display the translator of the language which is currently used in the user interface. Using gettext(), a simple way to achieve that is to mark the string for translation:

[C example ellipted] It is a good idea to use the customary msgid “translator-credits” for this purpose, since translators will already know the purpose of that msgid, and since Gtk::AboutDialog will detect if “translator-credits” is untranslated and hide the tab.

Parameters
translator_creditsThe translator credits.
void Gtk::AboutDialog::set_version ( const Glib::ustring version)

Sets the version string to display in the about dialog.

Parameters
versionThe version string.
void Gtk::AboutDialog::set_website ( const Glib::ustring website)

Sets the URL to use for the website link.

Parameters
websiteA URL string starting with "http://".
void Gtk::AboutDialog::set_website_label ( const Glib::ustring website_label)

Sets the label to be used for the website link.

Parameters
website_labelThe label used for the website link.
void Gtk::AboutDialog::set_wrap_license ( bool  wrap_license)

Sets whether the license text in about is automatically wrapped.

Parameters
wrap_licenseWhether to wrap the license.
Glib::SignalProxy<bool(const std::string&)> Gtk::AboutDialog::signal_activate_link ( )
Slot Prototype:
bool on_my_activate_link(const std::string& uri)

Flags: Run Last

The signal which gets emitted to activate a URI. Applications may connect to it to override the default behaviour, which is to call gtk_show_uri_on_window().

Parameters
uriThe URI that is activated.
Returns
true if the link has been activated.

Friends And Related Function Documentation

Gtk::AboutDialog* wrap ( GtkAboutDialog *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.