gtkmm  3.95.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::Range Class Reference

Base class for widgets which visualize an adjustment. More...

#include <gtkmm/range.h>

Inheritance diagram for Gtk::Range:
Inheritance graph
[legend]

Public Member Functions

 Range (Range&& src) noexcept
 
Rangeoperator= (Range&& src) noexcept
 
 Range (const Range&)=delete
 
Rangeoperator= (const Range&)=delete
 
 ~Range () noexcept override
 
GtkRange* gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkRange* gobj () const
 Provides access to the underlying C GObject. More...
 
void set_adjustment (const Glib::RefPtr< Adjustment >& adjustment)
 Sets the adjustment to be used as the “model” object for this range widget. More...
 
void unset_adjustment ()
 
Glib::RefPtr< Adjustmentget_adjustment ()
 Get the Gtk::Adjustment which is the “model” object for Gtk::Range. More...
 
Glib::RefPtr< const Adjustmentget_adjustment () const
 Get the Gtk::Adjustment which is the “model” object for Gtk::Range. More...
 
void set_inverted (bool setting=true)
 Ranges normally move from lower to higher values as the slider moves from top to bottom or left to right. More...
 
bool get_inverted () const
 Gets the value set by set_inverted(). More...
 
void set_flippable (bool flippable=true)
 If a range is flippable, it will switch its direction if it is horizontal and its direction is Gtk::TextDirection::RTL. More...
 
bool get_flippable () const
 Gets the value set by set_flippable(). More...
 
void set_slider_size_fixed (bool size_fixed=true)
 Sets whether the range’s slider has a fixed size, or a size that depends on its adjustment’s page size. More...
 
bool get_slider_size_fixed () const
 This function is useful mainly for Gtk::Range subclasses. More...
 
Gdk::Rectangle get_range_rect () const
 This method returns the area that contains the range's trough and its steppers, in the widget's Gdk::Surface coordinates. More...
 
void get_slider_range (int& slider_start, int& slider_end) const
 This function returns sliders range along the long dimension, in widget->window coordinates. More...
 
void set_increments (double step, double page)
 Sets the step and page sizes for the range. More...
 
void set_range (double min, double max)
 Sets the allowable values in the Gtk::Range, and clamps the range value to be between min and max. More...
 
void set_value (double value)
 Sets the current value of the range; if the value is outside the minimum or maximum range values, it will be clamped to fit inside them. More...
 
double get_value () const
 Gets the current value of the range. More...
 
void set_show_fill_level (bool show_fill_level=true)
 Sets whether a graphical fill level is show on the trough. More...
 
bool get_show_fill_level () const
 Gets whether the range displays the fill level graphically. More...
 
void set_restrict_to_fill_level (bool restrict_to_fill_level=true)
 Sets whether the slider is restricted to the fill level. More...
 
bool get_restrict_to_fill_level () const
 Gets whether the range is restricted to the fill level. More...
 
void set_fill_level (double fill_level)
 Set the new position of the fill level indicator. More...
 
double get_fill_level () const
 Gets the current position of the fill level indicator. More...
 
void set_round_digits (int round_digits)
 Sets the number of digits to round the value to when it changes. More...
 
int get_round_digits () const
 Gets the number of digits to round the value to when it changes. More...
 
Glib::SignalProxy< void()> signal_value_changed ()
 
Glib::SignalProxy< void(double)> signal_adjust_bounds ()
 
Glib::SignalProxy< void(ScrollType)> signal_move_slider ()
 
Glib::SignalProxy< bool(ScrollType, double)> signal_change_value ()
 
Glib::PropertyProxy< Glib::RefPtr< Adjustment > > property_adjustment ()
 The GtkAdjustment that contains the current value of this range object. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > > property_adjustment () const
 The GtkAdjustment that contains the current value of this range object. More...
 
Glib::PropertyProxy< bool > property_inverted ()
 Invert direction slider moves to increase range value. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_inverted () const
 Invert direction slider moves to increase range value. More...
 
Glib::PropertyProxy< bool > property_show_fill_level ()
 The show-fill-level property controls whether fill level indicator graphics are displayed on the trough. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_show_fill_level () const
 The show-fill-level property controls whether fill level indicator graphics are displayed on the trough. More...
 
Glib::PropertyProxy< bool > property_restrict_to_fill_level ()
 The restrict-to-fill-level property controls whether slider movement is restricted to an upper boundary set by the fill level. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_restrict_to_fill_level () const
 The restrict-to-fill-level property controls whether slider movement is restricted to an upper boundary set by the fill level. More...
 
Glib::PropertyProxy< double > property_fill_level ()
 The fill level (e.g. prebuffering of a network stream). More...
 
Glib::PropertyProxy_ReadOnly< double > property_fill_level () const
 The fill level (e.g. prebuffering of a network stream). More...
 
Glib::PropertyProxy< int > property_round_digits ()
 The number of digits to round the value to when it changes, or -1. More...
 
Glib::PropertyProxy_ReadOnly< int > property_round_digits () const
 The number of digits to round the value to when it changes, or -1. More...
 
- 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::Orientable
 Orientable (Orientable&& src) noexcept
 
Orientableoperator= (Orientable&& src) noexcept
 
 ~Orientable () noexcept override
 
GtkOrientable* gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkOrientable* gobj () const
 Provides access to the underlying C GObject. More...
 
void set_orientation (Orientation orientation)
 Sets the orientation of the orientable. More...
 
Orientation get_orientation () const
 Retrieves the orientation of the orientable. More...
 
Glib::PropertyProxy< Orientationproperty_orientation ()
 The orientation of the orientable. More...
 
Glib::PropertyProxy_ReadOnly< Orientationproperty_orientation () const
 The orientation of the orientable. 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::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::Orientable
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...
 

Protected Member Functions

 Range ()
 
virtual void get_range_border_vfunc (Gtk::Border& border) const
 
virtual void on_value_changed ()
 This is a default handler for the signal signal_value_changed(). More...
 
virtual void on_adjust_bounds (double new_value)
 This is a default handler for the signal signal_adjust_bounds(). More...
 
virtual void on_move_slider (ScrollType scroll)
 This is a default handler for the signal signal_move_slider(). More...
 
virtual bool on_change_value (ScrollType scroll, double new_value)
 This is a default handler for the signal signal_change_value(). 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::Orientable
 Orientable ()
 You should derive from this class to use it. More...
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- 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

Base class for widgets which visualize an adjustment.

Constructor & Destructor Documentation

Gtk::Range::Range ( Range&&  src)
noexcept
Gtk::Range::Range ( const Range )
delete
Gtk::Range::~Range ( )
overridenoexcept
Gtk::Range::Range ( )
protected

Member Function Documentation

Glib::RefPtr<Adjustment> Gtk::Range::get_adjustment ( )

Get the Gtk::Adjustment which is the “model” object for Gtk::Range.

See set_adjustment() for details. The return value does not have a reference added, so should not be unreferenced.

Returns
A Gtk::Adjustment.
Glib::RefPtr<const Adjustment> Gtk::Range::get_adjustment ( ) const

Get the Gtk::Adjustment which is the “model” object for Gtk::Range.

See set_adjustment() for details. The return value does not have a reference added, so should not be unreferenced.

Returns
A Gtk::Adjustment.
double Gtk::Range::get_fill_level ( ) const

Gets the current position of the fill level indicator.

Returns
The current fill level.
bool Gtk::Range::get_flippable ( ) const

Gets the value set by set_flippable().

Returns
true if the range is flippable.
bool Gtk::Range::get_inverted ( ) const

Gets the value set by set_inverted().

Returns
true if the range is inverted.
virtual void Gtk::Range::get_range_border_vfunc ( Gtk::Border border) const
protectedvirtual
Gdk::Rectangle Gtk::Range::get_range_rect ( ) const

This method returns the area that contains the range's trough and its steppers, in the widget's Gdk::Surface coordinates.

This method is useful mainly for Range subclasses.

Returns
The range rectangle.

@newin{2,20}

bool Gtk::Range::get_restrict_to_fill_level ( ) const

Gets whether the range is restricted to the fill level.

Returns
true if range is restricted to the fill level.
int Gtk::Range::get_round_digits ( ) const

Gets the number of digits to round the value to when it changes.

See Gtk::Range::signal_change_value().

Returns
The number of digits to round to.
bool Gtk::Range::get_show_fill_level ( ) const

Gets whether the range displays the fill level graphically.

Returns
true if range shows the fill level.
void Gtk::Range::get_slider_range ( int &  slider_start,
int &  slider_end 
) const

This function returns sliders range along the long dimension, in widget->window coordinates.

This function is useful mainly for Gtk::Range subclasses.

Parameters
slider_startReturn location for the slider's start, or nullptr.
slider_endReturn location for the slider's end, or nullptr.
bool Gtk::Range::get_slider_size_fixed ( ) const

This function is useful mainly for Gtk::Range subclasses.

See set_slider_size_fixed().

Returns
Whether the range’s slider has a fixed size.
static GType Gtk::Range::get_type ( )
static

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

double Gtk::Range::get_value ( ) const

Gets the current value of the range.

Returns
Current value of the range.
GtkRange* Gtk::Range::gobj ( )
inline

Provides access to the underlying C GObject.

const GtkRange* Gtk::Range::gobj ( ) const
inline

Provides access to the underlying C GObject.

virtual void Gtk::Range::on_adjust_bounds ( double  new_value)
protectedvirtual

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

virtual bool Gtk::Range::on_change_value ( ScrollType  scroll,
double  new_value 
)
protectedvirtual

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

virtual void Gtk::Range::on_move_slider ( ScrollType  scroll)
protectedvirtual

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

virtual void Gtk::Range::on_value_changed ( )
protectedvirtual

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

Range& Gtk::Range::operator= ( Range&&  src)
noexcept
Range& Gtk::Range::operator= ( const Range )
delete
Glib::PropertyProxy< Glib::RefPtr<Adjustment> > Gtk::Range::property_adjustment ( )

The GtkAdjustment that contains the current value of this range object.

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<Adjustment> > Gtk::Range::property_adjustment ( ) const

The GtkAdjustment that contains the current value of this range object.

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< double > Gtk::Range::property_fill_level ( )

The fill level (e.g. prebuffering of a network stream).

See Gtk::Range::set_fill_level().

Default value: 1.79769e+308

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< double > Gtk::Range::property_fill_level ( ) const

The fill level (e.g. prebuffering of a network stream).

See Gtk::Range::set_fill_level().

Default value: 1.79769e+308

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::Range::property_inverted ( )

Invert direction slider moves to increase range value.

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::Range::property_inverted ( ) const

Invert direction slider moves to increase range value.

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.
Glib::PropertyProxy< bool > Gtk::Range::property_restrict_to_fill_level ( )

The restrict-to-fill-level property controls whether slider movement is restricted to an upper boundary set by the fill level.

See Gtk::Range::set_restrict_to_fill_level().

Default value: true

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::Range::property_restrict_to_fill_level ( ) const

The restrict-to-fill-level property controls whether slider movement is restricted to an upper boundary set by the fill level.

See Gtk::Range::set_restrict_to_fill_level().

Default value: true

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< int > Gtk::Range::property_round_digits ( )

The number of digits to round the value to when it changes, or -1.

See Gtk::Range::signal_change_value().

Default value: -1

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< int > Gtk::Range::property_round_digits ( ) const

The number of digits to round the value to when it changes, or -1.

See Gtk::Range::signal_change_value().

Default value: -1

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::Range::property_show_fill_level ( )

The show-fill-level property controls whether fill level indicator graphics are displayed on the trough.

See Gtk::Range::set_show_fill_level().

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::Range::property_show_fill_level ( ) const

The show-fill-level property controls whether fill level indicator graphics are displayed on the trough.

See Gtk::Range::set_show_fill_level().

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::Range::set_adjustment ( const Glib::RefPtr< Adjustment >&  adjustment)

Sets the adjustment to be used as the “model” object for this range widget.

The adjustment indicates the current range value, the minimum and maximum range values, the step/page increments used for keybindings and scrolling, and the page size. The page size is normally 0 for Gtk::Scale and nonzero for Gtk::Scrollbar, and indicates the size of the visible area of the widget being scrolled. The page size affects the size of the scrollbar slider.

Parameters
adjustmentA Gtk::Adjustment.
void Gtk::Range::set_fill_level ( double  fill_level)

Set the new position of the fill level indicator.

The “fill level” is probably best described by its most prominent use case, which is an indicator for the amount of pre-buffering in a streaming media player. In that use case, the value of the range would indicate the current play position, and the fill level would be the position up to which the file/stream has been downloaded.

This amount of prebuffering can be displayed on the range’s trough and is themeable separately from the trough. To enable fill level display, use set_show_fill_level(). The range defaults to not showing the fill level.

Additionally, it’s possible to restrict the range’s slider position to values which are smaller than the fill level. This is controller by set_restrict_to_fill_level() and is by default enabled.

Parameters
fill_levelThe new position of the fill level indicator.
void Gtk::Range::set_flippable ( bool  flippable = true)

If a range is flippable, it will switch its direction if it is horizontal and its direction is Gtk::TextDirection::RTL.

See Gtk::Widget::get_direction().

Parameters
flippabletrue to make the range flippable.
void Gtk::Range::set_increments ( double  step,
double  page 
)

Sets the step and page sizes for the range.

The step size is used when the user clicks the Gtk::Scrollbar arrows or moves Gtk::Scale via arrow keys. The page size is used for example when moving via Page Up or Page Down keys.

Parameters
stepStep size.
pagePage size.
void Gtk::Range::set_inverted ( bool  setting = true)

Ranges normally move from lower to higher values as the slider moves from top to bottom or left to right.

Inverted ranges have higher values at the top or on the right rather than on the bottom or left.

Parameters
settingtrue to invert the range.
void Gtk::Range::set_range ( double  min,
double  max 
)

Sets the allowable values in the Gtk::Range, and clamps the range value to be between min and max.

(If the range has a non-zero page size, it is clamped between min and max - page-size.)

Parameters
minMinimum range value.
maxMaximum range value.
void Gtk::Range::set_restrict_to_fill_level ( bool  restrict_to_fill_level = true)

Sets whether the slider is restricted to the fill level.

See set_fill_level() for a general description of the fill level concept.

Parameters
restrict_to_fill_levelWhether the fill level restricts slider movement.
void Gtk::Range::set_round_digits ( int  round_digits)

Sets the number of digits to round the value to when it changes.

See Gtk::Range::signal_change_value().

Parameters
round_digitsThe precision in digits, or -1.
void Gtk::Range::set_show_fill_level ( bool  show_fill_level = true)

Sets whether a graphical fill level is show on the trough.

See set_fill_level() for a general description of the fill level concept.

Parameters
show_fill_levelWhether a fill level indicator graphics is shown.
void Gtk::Range::set_slider_size_fixed ( bool  size_fixed = true)

Sets whether the range’s slider has a fixed size, or a size that depends on its adjustment’s page size.

This function is useful mainly for Gtk::Range subclasses.

Parameters
size_fixedtrue to make the slider size constant.
void Gtk::Range::set_value ( double  value)

Sets the current value of the range; if the value is outside the minimum or maximum range values, it will be clamped to fit inside them.

The range emits the Gtk::Range::signal_value_changed() signal if the value changes.

Parameters
valueNew value of the range.
Glib::SignalProxy<void(double)> Gtk::Range::signal_adjust_bounds ( )
Slot Prototype:
void on_my_adjust_bounds(double new_value)

Flags: Run Last

Emitted before clamping a value, to give the application a chance to adjust the bounds.

Parameters
new_valueThe value before we clamp.
Glib::SignalProxy<bool(ScrollType, double)> Gtk::Range::signal_change_value ( )
Slot Prototype:
bool on_my_change_value(ScrollType scroll, double new_value)

Flags: Run Last

The Gtk::Range::signal_change_value() signal is emitted when a scroll action is performed on a range. It allows an application to determine the type of scroll event that occurred and the resultant new value. The application can handle the event itself and return true to prevent further processing. Or, by returning false, it can pass the event to other handlers until the default GTK+ handler is reached.

The value parameter is unrounded. An application that overrides the GtkRange::change-value signal is responsible for clamping the value to the desired number of decimal digits; the default GTK+ handler clamps the value based on Gtk::Range::property_round_digits().

Parameters
scrollThe type of scroll action that was performed.
new_valueThe new value resulting from the scroll action.
Returns
true to prevent other handlers from being invoked for the signal, false to propagate the signal further.
Glib::SignalProxy<void(ScrollType)> Gtk::Range::signal_move_slider ( )
Slot Prototype:
void on_my_move_slider(ScrollType scroll)

Flags: Run Last, Action

Virtual function that moves the slider. Used for keybindings.

Parameters
scrollHow to move the slider.
Glib::SignalProxy<void()> Gtk::Range::signal_value_changed ( )
Slot Prototype:
void on_my_value_changed()

Flags: Run Last

Emitted when the range value changes.

void Gtk::Range::unset_adjustment ( )

Friends And Related Function Documentation

Gtk::Range* wrap ( GtkRange *  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.