gtkmm
3.93.0
|
A toolbar to integrate a search entry with. More...
#include <gtkmm/searchbar.h>
Public Member Functions | |
SearchBar (SearchBar&& src) noexcept | |
SearchBar& | operator= (SearchBar&& src) noexcept |
SearchBar (const SearchBar&)=delete | |
SearchBar& | operator= (const SearchBar&)=delete |
~SearchBar () noexcept override | |
GtkSearchBar* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkSearchBar* | gobj () const |
Provides access to the underlying C GObject. More... | |
SearchBar () | |
Creates a Gtk::SearchBar. More... | |
void | connect_entry (Gtk::Entry& entry) |
Connects the Gtk::Entry widget passed as the one to be used in this search bar. More... | |
bool | get_search_mode () const |
Returns whether the search mode is on or off. More... | |
void | set_search_mode (bool search_mode=true) |
Switches the search mode on or off. More... | |
bool | get_show_close_button () const |
Returns whether the close button is shown. More... | |
void | set_show_close_button (bool visible=true) |
Shows or hides the close button. More... | |
bool | handle_event (const Glib::RefPtr< Gdk::EventKey >& gdk_event) |
This function should be called when the top-level window which contains the search bar received a key event. More... | |
Glib::PropertyProxy< bool > | property_search_mode_enabled () |
Whether the search mode is on and the search bar shown. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_search_mode_enabled () const |
Whether the search mode is on and the search bar shown. More... | |
Glib::PropertyProxy< bool > | property_show_close_button () |
Whether to show the close button in the search bar. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_show_close_button () const |
Whether to show the close button in the search bar. More... | |
![]() | |
Bin (Bin&& src) noexcept | |
Bin& | operator= (Bin&& src) noexcept |
Bin (const Bin&)=delete | |
Bin& | operator= (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::Widget* | get_child () |
Gets the child of the Gtk::Bin, or nullptr if the bin contains no child widget. More... | |
const Gtk::Widget* | get_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... | |
![]() | |
Container (Container&& src) noexcept | |
Container& | operator= (Container&& src) noexcept |
Container (const Container&)=delete | |
Container& | operator= (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 | check_resize () |
Request that contained widgets check their size. 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_chain (const std::vector< Widget*>& focusable_widgets) |
Sets a focus chain, overriding the one computed automatically by GTK+. More... | |
bool | has_focus_chain () const |
std::vector< Widget* > | get_focus_chain () |
std::vector< const Widget* > | get_focus_chain () const |
void | unset_focus_chain () |
Removes a focus chain explicitly set with set_focus_chain(). 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< Adjustment > | get_focus_vadjustment () |
Retrieves the vertical focus adjustment for the container. More... | |
Glib::RefPtr< const Adjustment > | get_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< Adjustment > | get_focus_hadjustment () |
Retrieves the horizontal focus adjustment for the container. More... | |
Glib::RefPtr< const Adjustment > | get_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 () |
Glib::SignalProxy< void()> | signal_check_resize () |
![]() | |
Widget (Widget&& src) noexcept | |
Widget& | operator= (Widget&& src) noexcept |
Widget (const Widget&)=delete | |
Widget& | operator= (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 () |
Equivalent to calling queue_draw_area() for the entire area of a widget. More... | |
void | queue_draw_area (int x, int y, int width, int height) |
Convenience function that calls queue_draw_region() on the region created from the given coordinates. More... | |
void | queue_draw_region (const Cairo::RefPtr< const Cairo::Region >& region) |
Invalidates the area of widget defined by region. 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, Allocation& out_clip) |
This function is only used by Gtk::Widget subclasses, to assign a size, position and (optionally) baseline to their child widgets. 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 | 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 | send_focus_change (const Glib::RefPtr< const Gdk::EventFocus >& gdk_event) |
Sends the focus change gdk_event to widget. 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... | |
bool | intersect (const Gdk::Rectangle& area) const |
bool | intersect (const Gdk::Rectangle& area, Gdk::Rectangle& intersection) const |
Computes the intersection of a widget’s area and area, storing the intersection in intersection, and returns true if there was an intersection. More... | |
void | freeze_child_notify () |
Stops emission of Gtk::Widget::signal_child_notify() signals on widget. More... | |
void | child_notify (const Glib::ustring& child_property) |
Emits a Gtk::Widget::signal_child_notify() signal for the [child property][child-properties] child_property on widget. More... | |
void | thaw_child_notify () |
Reverts the effect of a previous call to freeze_child_notify(). 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 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_default (bool can_default=true) |
Specifies whether widget can be a default widget. More... | |
bool | get_can_default () const |
Determines whether widget can be a default widget. More... | |
bool | has_default () const |
Determines whether widget is the current default widget within its toplevel. More... | |
void | grab_default () |
Causes widget to become the default widget. 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_window () const |
Determines whether widget has a Gdk::Window 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::Window > | get_window () |
Returns the widget’s window if it is realized, nullptr otherwise. More... | |
Glib::RefPtr< const Gdk::Window > | get_window () const |
Returns the widget’s window if it is realized, nullptr otherwise. More... | |
void | register_window (const Glib::RefPtr< Gdk::Window >& window) |
Registers a Gdk::Window with the widget and sets it up so that the widget receives events for it. More... | |
void | unregister_window (const Glib::RefPtr< Gdk::Window >& window) |
Unregisters a Gdk::Window from the widget that was previously set up with register_window(). 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... | |
void | get_allocated_size (Allocation& allocation, int& baseline) const |
Retrieves the widget’s allocated size. 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... | |
Allocation | get_clip () const |
Retrieves the widget’s clip area. More... | |
Container* | get_parent () |
Returns the parent widget of widget. More... | |
const Container* | get_parent () const |
Returns the parent widget of widget. More... | |
Glib::RefPtr< Gdk::Window > | get_parent_window () |
Gets widget’s parent window, or nullptr if it does not have one. More... | |
Glib::RefPtr< const Gdk::Window > | get_parent_window () const |
Gets widget’s parent window, or nullptr if it does not have one. More... | |
void | set_parent_window (const Glib::RefPtr< const Gdk::Window >& parent_window) |
Sets a non default parent window for 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, and Gtk::Container::set_focus_chain() to change the focus tab order. 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... | |
Container* | get_toplevel () |
This function returns the topmost widget in the container hierarchy widget is a part of. More... | |
const Container* | get_toplevel () const |
This function returns the topmost widget in the container hierarchy widget is a part of. More... | |
Widget* | get_ancestor (GType widget_type) |
Gets the first ancestor of widget with type widget_type. More... | |
const Widget* | get_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::Display > | get_display () |
Get the Gdk::Display for the toplevel window associated with this widget. More... | |
Glib::RefPtr< const Gdk::Display > | get_display () const |
Get the Gdk::Display for the toplevel window associated with this widget. More... | |
Glib::RefPtr< Settings > | get_settings () |
Gets the settings object holding the settings used for this widget. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_clipboard () |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_clipboard () const |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_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::Clipboard > | get_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... | |
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::Object > | get_accessible () |
Returns the accessible object that describes the widget to an assistive technology. More... | |
Glib::RefPtr< const Atk::Object > | get_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... | |
Widget* | pick (double x, double y) |
Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More... | |
const Widget* | pick (double x, double y) const |
Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More... | |
void | reset_style () |
Updates the style context of widget and all descendants by updating its widget path. More... | |
Glib::RefPtr< Pango::Context > | create_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::Context > | get_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::Layout > | create_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 | shape_combine_region (const Cairo::RefPtr< const Cairo::Region >& region) |
Sets a shape for this widget’s GDK window. More... | |
void | input_shape_combine_region (const Cairo::RefPtr< const Cairo::Region >& region) |
Sets an input shape for this widget’s GDK window. 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::Cursor > | get_cursor () |
Queries the cursor set via set_cursor(). More... | |
Glib::RefPtr< const Gdk::Cursor > | get_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::DragContext >& context, const Glib::ustring& target, guint32 time) |
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::DragContext >& context, const Glib::RefPtr< Gdk::ContentFormats >& target_list) const |
Looks for a match between context->targets and the dest_target_list, returning the first matching target, otherwise returning GDK_NONE. More... | |
Glib::ustring | drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext >& context) const |
Glib::RefPtr< Gdk::ContentFormats > | drag_dest_get_target_list () |
Returns the list of targets this widget can accept from drag-and-drop. More... | |
Glib::RefPtr< const Gdk::ContentFormats > | drag_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_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... | |
void | drag_source_set_icon (const Cairo::RefPtr< Cairo::Surface >& surface) |
Sets the icon that will be used for drags from a particular widget from a cairo surface. 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_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::DragContext > | drag_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 | drag_set_as_icon (const Glib::RefPtr< Gdk::DragContext >& context, int hot_x, int hot_y) |
void | queue_resize_no_redraw () |
This function works like queue_resize(), except that the widget is not invalidated. More... | |
Glib::RefPtr< Gdk::FrameClock > | get_frame_clock () |
Obtains the frame clock for a widget. More... | |
Glib::RefPtr< const Gdk::FrameClock > | get_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... | |
Window* | get_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< StyleContext > | get_style_context () |
Returns the style context associated to widget. More... | |
Glib::RefPtr< Gtk::StyleContext > | get_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::ActionGroup > | get_action_group (const Glib::ustring& prefix) |
Retrieves the Gio::ActionGroup that was registered using prefix. More... | |
Glib::RefPtr< const Gio::ActionGroup > | get_action_group (const Glib::ustring& prefix) const |
Retrieves the Gio::ActionGroup that was registered using prefix. More... | |
std::vector< Glib::ustring > | list_action_prefixes () const |
Retrieves a nullptr -terminated array of strings containing the prefixes of Gio::ActionGroup's available to 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::FontMap > | get_font_map () |
Gets the font map that has been set with set_font_map(). More... | |
Glib::RefPtr< const Pango::FontMap > | get_font_map () const |
Gets the font map that has been set with set_font_map(). More... | |
Widget* | get_first_child () |
const Widget* | get_first_child () const |
Widget* | get_last_child () |
const Widget* | get_last_child () const |
Widget* | get_next_sibling () |
const Widget* | get_next_sibling () const |
Widget* | get_prev_sibling () |
const Widget* | get_prev_sibling () const |
void | insert_after (Widget& parent, Widget& previous_sibling) |
Inserts widget into the child widget list of parent. More... | |
void | insert_after (Widget& parent) |
A insert_after() convenience overload. More... | |
void | insert_before (Widget& parent, Widget& next_sibling) |
Inserts widget into the child widget list of parent. More... | |
void | insert_before (Widget& parent) |
A insert_before() convenience overload. More... | |
void | snapshot_child (Widget& child, 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(const Allocation&, int, Allocation&)> | signal_size_allocate () |
Glib::SignalProxy< void(Gtk::StateFlags)> | signal_state_flags_changed () |
Glib::SignalProxy< void(Widget*)> | signal_hierarchy_changed () |
Glib::SignalProxy< void()> | signal_style_updated () |
Glib::SignalProxy< void(TextDirection)> | signal_direction_changed () |
Glib::SignalProxy< void(bool)> | signal_grab_notify () |
Glib::SignalProxyDetailed< void(GParamSpec*)> | signal_child_notify (const Glib::ustring& child_property_name=Glib::ustring()) |
Glib::SignalProxy< bool(bool)> | signal_mnemonic_activate () |
Glib::SignalProxy< void()> | signal_grab_focus () |
Glib::SignalProxy< bool(DirectionType)> | signal_focus () |
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::Event >&)> | signal_event () |
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::EventKey >&)> | signal_key_press_event () |
Event triggered by a key press will widget has focus. More... | |
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::EventKey >&)> | signal_key_release_event () |
Event triggered by a key release will widget has focus. More... | |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::DragContext >&)> | signal_drag_begin () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::DragContext >&)> | signal_drag_end () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::DragContext >&, SelectionData&, guint)> | signal_drag_data_get () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::DragContext >&)> | signal_drag_data_delete () |
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::DragContext >&, DragResult)> | signal_drag_failed () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::DragContext >&, guint)> | signal_drag_leave () |
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::DragContext >&, int, int, guint)> | signal_drag_motion () |
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::DragContext >&, int, int, guint)> | signal_drag_drop () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::DragContext >&, const SelectionData&, guint)> | signal_drag_data_received () |
Glib::SignalProxy< void()> | signal_accel_closures_changed () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Display >&)> | signal_display_changed () |
Glib::SignalProxy< bool()> | signal_popup_menu () |
Glib::SignalProxy< bool(int, int, bool, const Glib::RefPtr< Tooltip >&)> | signal_query_tooltip () |
Glib::PropertyProxy< Glib::ustring > | property_name () |
The name of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
The name of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Container*> | property_parent () const |
The parent widget of this 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_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< bool > | property_can_default () |
Whether the widget can be the default widget. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_default () const |
Whether the widget can be the default widget. More... | |
Glib::PropertyProxy< bool > | property_has_default () |
Whether the widget is the default widget. 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::ustring > | property_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::ustring > | property_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::ustring > | property_tooltip_text () |
Sets the text of tooltip to be the given string. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_text () const |
Sets the text of tooltip to be the given string. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Window > > | property_window () const |
The widget's window if it is realized, nullptr otherwise. More... | |
Glib::PropertyProxy< Align > | property_halign () |
How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_halign () const |
How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy< Align > | property_valign () |
How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_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_ReadOnly< int > | property_scale_factor () const |
The scale factor of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_css_name () const |
The name of this widget in the CSS tree. More... | |
![]() | |
Object (Object&& src) noexcept | |
Object& | operator= (Object&& src) noexcept |
~Object () noexcept override | |
![]() | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (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::Object > | wrap (GObject *object, bool take_copy=false) |
![]() | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (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 |
![]() | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) | |
~trackable () | |
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) |
void | remove_destroy_notify_callback (void *data) const |
![]() | |
Buildable (Buildable&& src) noexcept | |
Buildable& | operator= (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... | |
![]() | |
Interface () | |
Interface (Interface &&src) noexcept | |
Interface & | operator= (Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Interface (GObject *castitem) | |
~Interface () noexcept override | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
![]() | |
Implementor (Implementor &&src) noexcept | |
Implementor & | operator= (Implementor &&src) noexcept |
~Implementor () noexcept override | |
AtkImplementor * | gobj () |
const AtkImplementor * | gobj () const |
Glib::RefPtr< Atk::Implementor > | wrap (AtkImplementor *object, bool take_copy=false) |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static Widget* | get_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 Widget* | drag_get_source_widget (const Glib::RefPtr< Gdk::DragContext >& context) |
![]() | |
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 void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Related Functions | |
(Note that these are not member functions.) | |
Gtk::SearchBar* | wrap (GtkSearchBar* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Gtk::Bin* | wrap (GtkBin* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Gtk::Container* | wrap (GtkContainer* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Gtk::Widget* | wrap (GtkWidget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
![]() | |
using | ForeachSlot = sigc::slot< void(Widget&)> |
For instance, void on_foreach(Gtk::Widget& widget);. More... | |
![]() | |
using | SlotTick = sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock >&)> |
Callback type for adding a function to update animations. More... | |
![]() | |
typedef void(*)(gpointer data | DestroyNotify) |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
![]() | |
Bin () | |
This constructor is protected because only derived classes should be instantiated. More... | |
![]() | |
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_child_property_vfunc (Widget* child, guint property_id, const Glib::ValueBase& value, GParamSpec* pspec) |
Sets a child property for this container and its child. More... | |
virtual void | get_child_property_vfunc (const Widget* child, guint property_id, Glib::ValueBase& value, GParamSpec* pspec) const |
Returns a child property for this container and its child. 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... | |
virtual void | on_check_resize () |
This is a default handler for the signal signal_check_resize(). More... | |
![]() | |
virtual void | dispatch_child_properties_changed_vfunc (guint p1, GParamSpec** p2) |
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 Glib::RefPtr< Atk::Object > | get_accessible_vfunc () |
virtual void | compute_expand_vfunc (bool& hexpand_p, bool& vexpand_p) |
virtual bool | contains_vfunc (double x, double y) const |
virtual Widget* | pick_vfunc (double x, double y) |
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 | draw (const Cairo::RefPtr< Cairo::Context >& cr) |
Draws widget to cr. More... | |
void | set_realized (bool realized=true) |
Marks the widget as being realized. More... | |
void | set_has_window (bool has_window=true) |
Specifies whether widget has a Gdk::Window of its own. More... | |
void | set_window (const Glib::RefPtr< Gdk::Window >& window) |
Sets a widget's window. More... | |
void | realize_if_needed () |
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 (const Allocation& allocation, int baseline, Allocation& out_clip) |
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_hierarchy_changed (Widget* previous_toplevel) |
This is a default handler for the signal signal_hierarchy_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 void | on_child_notify (GParamSpec* pspec) |
This is a default handler for the signal signal_child_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_grab_focus () |
This is a default handler for the signal signal_grab_focus(). More... | |
virtual bool | on_focus (DirectionType direction) |
This is a default handler for the signal signal_focus(). More... | |
virtual bool | on_event (const Glib::RefPtr< Gdk::Event >& gdk_event) |
This is a default handler for the signal signal_event(). More... | |
virtual bool | on_key_press_event (const Glib::RefPtr< Gdk::EventKey >& key_event) |
This is a default handler for the signal signal_key_press_event(). More... | |
virtual bool | on_key_release_event (const Glib::RefPtr< Gdk::EventKey >& key_event) |
This is a default handler for the signal signal_key_release_event(). More... | |
virtual void | on_drag_begin (const Glib::RefPtr< Gdk::DragContext >& context) |
This is a default handler for the signal signal_drag_begin(). More... | |
virtual void | on_drag_end (const Glib::RefPtr< Gdk::DragContext >& context) |
This is a default handler for the signal signal_drag_end(). More... | |
virtual void | on_drag_data_get (const Glib::RefPtr< Gdk::DragContext >& context, SelectionData& selection_data, guint time) |
This is a default handler for the signal signal_drag_data_get(). More... | |
virtual void | on_drag_data_delete (const Glib::RefPtr< Gdk::DragContext >& context) |
This is a default handler for the signal signal_drag_data_delete(). More... | |
virtual bool | on_drag_failed (const Glib::RefPtr< Gdk::DragContext >& context, DragResult result) |
This is a default handler for the signal signal_drag_failed(). More... | |
virtual void | on_drag_leave (const Glib::RefPtr< Gdk::DragContext >& context, guint time) |
This is a default handler for the signal signal_drag_leave(). More... | |
virtual bool | on_drag_motion (const Glib::RefPtr< Gdk::DragContext >& context, int x, int y, guint time) |
This is a default handler for the signal signal_drag_motion(). More... | |
virtual bool | on_drag_drop (const Glib::RefPtr< Gdk::DragContext >& context, int x, int y, guint time) |
This is a default handler for the signal signal_drag_drop(). More... | |
virtual void | on_drag_data_received (const Glib::RefPtr< Gdk::DragContext >& context, const SelectionData& selection_data, guint time) |
This is a default handler for the signal signal_drag_data_received(). More... | |
virtual void | on_display_changed (const Glib::RefPtr< Gdk::Display >& previous_display) |
This is a default handler for the signal signal_display_changed(). 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... | |
![]() | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexcept override | |
![]() | |
ObjectBase () | |
ObjectBase (const char *custom_type_name) | |
ObjectBase (const std::type_info &custom_type_info) | |
ObjectBase (ObjectBase &&src) noexcept | |
ObjectBase & | operator= (ObjectBase &&src) noexcept |
virtual | ~ObjectBase () noexcept=0 |
void | initialize (GObject *castitem) |
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
![]() | |
Buildable () | |
You should derive from this class to use it. More... | |
![]() | |
Implementor () | |
virtual Glib::RefPtr< Object > | ref_accessibile_vfunc () |
A toolbar to integrate a search entry with.
Gtk::SearchBar is a container made to have a search entry (possibly with additional connex widgets, such as drop-down menus, or buttons) built-in. The search bar would appear when a search is started through typing on the keyboard, or the application's search mode is toggled on.
For keyboard presses to start a search, events will need to be forwarded from the top-level window that contains the search bar. See Gtk::SearchBar::handle_event() for example code. Common shortcuts such as Ctrl+F should be handled as an application action, or through the menu items.
You will also need to tell the search bar about which entry you are using as your search entry using Gtk::SearchBar::connect_entry().
|
noexcept |
|
delete |
|
overridenoexcept |
Gtk::SearchBar::SearchBar | ( | ) |
Creates a Gtk::SearchBar.
You will need to tell it about which widget is going to be your text entry using Gtk::SearchBar::connect_entry().
void Gtk::SearchBar::connect_entry | ( | Gtk::Entry& | entry | ) |
Connects the Gtk::Entry widget passed as the one to be used in this search bar.
The entry should be a descendant of the search bar. This is only required if the entry isn’t the direct child of the search bar (as in our main example).
entry | A Gtk::Entry. |
bool Gtk::SearchBar::get_search_mode | ( | ) | const |
Returns whether the search mode is on or off.
bool Gtk::SearchBar::get_show_close_button | ( | ) | const |
Returns whether the close button is shown.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
bool Gtk::SearchBar::handle_event | ( | const Glib::RefPtr< Gdk::EventKey >& | gdk_event | ) |
This function should be called when the top-level window which contains the search bar received a key event.
If the key event is handled by the search bar, the bar will be shown, the entry populated with the entered text and GDK_EVENT_STOP will be returned. The caller should ensure that events are not propagated further.
If no entry has been connected to the search bar, using connect_entry(), this function will return immediately with a warning.
[C example ellipted]
gdk_event | A Gdk::Event containing key press events. |
Glib::PropertyProxy< bool > Gtk::SearchBar::property_search_mode_enabled | ( | ) |
Whether the search mode is on and the search bar shown.
See Gtk::SearchBar::set_search_mode() for details.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::SearchBar::property_search_mode_enabled | ( | ) | const |
Whether the search mode is on and the search bar shown.
See Gtk::SearchBar::set_search_mode() for details.
Default value: false
Glib::PropertyProxy< bool > Gtk::SearchBar::property_show_close_button | ( | ) |
Whether to show the close button in the search bar.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::SearchBar::property_show_close_button | ( | ) | const |
Whether to show the close button in the search bar.
Default value: false
void Gtk::SearchBar::set_search_mode | ( | bool | search_mode = true | ) |
Switches the search mode on or off.
search_mode | The new state of the search mode. |
void Gtk::SearchBar::set_show_close_button | ( | bool | visible = true | ) |
Shows or hides the close button.
Applications that already have a “search” toggle button should not show a close button in their search bar, as it duplicates the role of the toggle button.
visible | Whether the close button will be shown or not. |
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |