This interface is implemented by widgets with native scrolling ability. More...

#include <gtkmm/scrollable.h>

Inheritance diagram for Gtk::Scrollable:

Public Types
enum	Policy {   Policy::MINIMUM,   Policy::NATURAL }
	Defines the policy to be used in a scrollable widget when updating the scrolled window adjustments in a given orientation. More...
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

Public Member Functions
	Scrollable (Scrollable&& src) noexcept
Scrollable&	operator= (Scrollable&& src) noexcept
	~Scrollable () noexcept override
GtkScrollable*	gobj ()
	Provides access to the underlying C GObject. More...
const GtkScrollable*	gobj () const
	Provides access to the underlying C GObject. More...
Glib::RefPtr< Adjustment >	get_hadjustment ()
	Retrieves the Gtk::Adjustment used for horizontal scrolling. More...
Glib::RefPtr< const Adjustment >	get_hadjustment () const
	Retrieves the Gtk::Adjustment used for horizontal scrolling. More...
void	set_hadjustment (const Glib::RefPtr< Adjustment >& hadjustment)
	Sets the horizontal adjustment of the Gtk::Scrollable. More...
void	unset_hadjustment ()
	This method removes the hadjustment. More...
Glib::RefPtr< Adjustment >	get_vadjustment ()
	Retrieves the Gtk::Adjustment used for vertical scrolling. More...
Glib::RefPtr< const Adjustment >	get_vadjustment () const
	Retrieves the Gtk::Adjustment used for vertical scrolling. More...
void	set_vadjustment (const Glib::RefPtr< Adjustment >& vadjustment)
	Sets the vertical adjustment of the Gtk::Scrollable. More...
void	unset_vadjustment ()
	This method removes the vadjustment. More...
Policy	get_hscroll_policy () const
	Gets the horizontal Gtk::Scrollable::Policy. More...
void	set_hscroll_policy (Policy policy)
	Sets the Gtk::Scrollable::Policy to determine whether horizontal scrolling should start below the minimum width or below the natural width. More...
Policy	get_vscroll_policy () const
	Gets the vertical Gtk::Scrollable::Policy. More...
void	set_vscroll_policy (Policy policy)
	Sets the Gtk::Scrollable::Policy to determine whether vertical scrolling should start below the minimum height or below the natural height. More...
bool	get_border (Border& border) const
	Returns the size of a non-scrolling border around the outside of the scrollable. More...
Glib::PropertyProxy< Glib::RefPtr< Adjustment > >	property_hadjustment ()
	Horizontal Gtk::Adjustment of the scrollable widget. More...
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > >	property_hadjustment () const
	Horizontal Gtk::Adjustment of the scrollable widget. More...
Glib::PropertyProxy< Glib::RefPtr< Adjustment > >	property_vadjustment ()
	Vertical Gtk::Adjustment of the scrollable widget. More...
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > >	property_vadjustment () const
	Vertical Gtk::Adjustment of the scrollable widget. More...
Glib::PropertyProxy< Policy >	property_hscroll_policy ()
	Determines whether horizontal scrolling should start once the scrollable widget is allocated less than its minimum width or less than its natural width. More...
Glib::PropertyProxy_ReadOnly< Policy >	property_hscroll_policy () const
	Determines whether horizontal scrolling should start once the scrollable widget is allocated less than its minimum width or less than its natural width. More...
Glib::PropertyProxy< Policy >	property_vscroll_policy ()
	Determines whether vertical scrolling should start once the scrollable widget is allocated less than its minimum height or less than its natural height. More...
Glib::PropertyProxy_ReadOnly< Policy >	property_vscroll_policy () const
	Determines whether vertical scrolling should start once the scrollable widget is allocated less than its minimum height or less than its natural height. More...
Public Member Functions inherited from Glib::Interface
	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
Public Member Functions inherited from Glib::ObjectBase
	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
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 ()
trackable &	operator= (const trackable &src)
trackable &	operator= (trackable &&src) noexcept
void	remove_destroy_notify_callback (notifiable *data) const

Static Public Member Functions
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
	Scrollable ()
	You should derive from this class to use it. More...
virtual bool	get_border_vfunc (Border& border) const
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
ObjectBase &	operator= (ObjectBase &&src) noexcept
virtual	~ObjectBase () noexcept=0
void	initialize (GObject *castitem)
void	initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gtk::Scrollable >	wrap (GtkScrollable* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Detailed Description

This interface is implemented by widgets with native scrolling ability.

Since gtkmm 3.0:

Constructor & Destructor Documentation

Gtk::Scrollable::Scrollable ( )

protected

You should derive from this class to use it.

Gtk::Scrollable::Scrollable ( Scrollable&&  src )

noexcept

Gtk::Scrollable::~Scrollable ( )

overridenoexcept

Member Function Documentation

static void Gtk::Scrollable::add_interface ( GType  gtype_implementer )

static

bool Gtk::Scrollable::get_border

(

Border&

border

)

const

Returns the size of a non-scrolling border around the outside of the scrollable.

An example for this would be treeview headers. GTK can use this information to display overlaid graphics, like the overshoot indication, at the right position.

Parameters

border

Return location for the results.

Returns

true if border has been set.

virtual bool Gtk::Scrollable::get_border_vfunc ( Border&  border ) const

protectedvirtual

Glib::RefPtr<Adjustment> Gtk::Scrollable::get_hadjustment

(

)

Retrieves the Gtk::Adjustment used for horizontal scrolling.

Returns

Horizontal Gtk::Adjustment.

Glib::RefPtr<const Adjustment> Gtk::Scrollable::get_hadjustment

(

)

const

Retrieves the Gtk::Adjustment used for horizontal scrolling.

Returns

Horizontal Gtk::Adjustment.

Policy Gtk::Scrollable::get_hscroll_policy

(

)

const

Gets the horizontal Gtk::Scrollable::Policy.

Returns

The horizontal Gtk::Scrollable::Policy.

static GType Gtk::Scrollable::get_type ( )

static

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

Glib::RefPtr<Adjustment> Gtk::Scrollable::get_vadjustment

(

)

Retrieves the Gtk::Adjustment used for vertical scrolling.

Returns

Vertical Gtk::Adjustment.

Glib::RefPtr<const Adjustment> Gtk::Scrollable::get_vadjustment

(

)

const

Retrieves the Gtk::Adjustment used for vertical scrolling.

Returns

Vertical Gtk::Adjustment.

Policy Gtk::Scrollable::get_vscroll_policy

(

)

const

Gets the vertical Gtk::Scrollable::Policy.

Returns

The vertical Gtk::Scrollable::Policy.

GtkScrollable* Gtk::Scrollable::gobj ( )

inline

Provides access to the underlying C GObject.

const GtkScrollable* Gtk::Scrollable::gobj ( ) const

inline

Provides access to the underlying C GObject.

Scrollable& Gtk::Scrollable::operator= ( Scrollable&&  src )

noexcept

Glib::PropertyProxy< Glib::RefPtr<Adjustment> > Gtk::Scrollable::property_hadjustment

(

)

Horizontal Gtk::Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

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::Scrollable::property_hadjustment

(

)

const

Horizontal Gtk::Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

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< Policy > Gtk::Scrollable::property_hscroll_policy

(

)

Determines whether horizontal scrolling should start once the scrollable widget is allocated less than its minimum width or less than its natural width.

Default value: Gtk::Scrollabel::Policy::MINIMUM

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< Policy > Gtk::Scrollable::property_hscroll_policy

(

)

const

Determines whether horizontal scrolling should start once the scrollable widget is allocated less than its minimum width or less than its natural width.

Default value: Gtk::Scrollabel::Policy::MINIMUM

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

Glib::PropertyProxy< Glib::RefPtr<Adjustment> > Gtk::Scrollable::property_vadjustment

(

)

Vertical Gtk::Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

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::Scrollable::property_vadjustment

(

)

const

Vertical Gtk::Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

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< Policy > Gtk::Scrollable::property_vscroll_policy

(

)

Determines whether vertical scrolling should start once the scrollable widget is allocated less than its minimum height or less than its natural height.

Default value: Gtk::Scrollabel::Policy::MINIMUM

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< Policy > Gtk::Scrollable::property_vscroll_policy

(

)

const

Determines whether vertical scrolling should start once the scrollable widget is allocated less than its minimum height or less than its natural height.

Default value: Gtk::Scrollabel::Policy::MINIMUM

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::Scrollable::set_hadjustment

(

const Glib::RefPtr< Adjustment >&

hadjustment

)

Sets the horizontal adjustment of the Gtk::Scrollable.

Parameters

hadjustment

A Gtk::Adjustment.

void Gtk::Scrollable::set_hscroll_policy

(

Policy

policy

)

Sets the Gtk::Scrollable::Policy to determine whether horizontal scrolling should start below the minimum width or below the natural width.

Parameters

policy

The horizontal Gtk::Scrollable::Policy.

void Gtk::Scrollable::set_vadjustment

(

const Glib::RefPtr< Adjustment >&

vadjustment

)

Sets the vertical adjustment of the Gtk::Scrollable.

Parameters

vadjustment

A Gtk::Adjustment.

void Gtk::Scrollable::set_vscroll_policy

(

Policy

policy

)

Sets the Gtk::Scrollable::Policy to determine whether vertical scrolling should start below the minimum height or below the natural height.

Parameters

policy

The vertical Gtk::Scrollable::Policy.

void Gtk::Scrollable::unset_hadjustment

(

)

This method removes the hadjustment.

See also

set_hadjustment().

void Gtk::Scrollable::unset_vadjustment

(

)

This method removes the vadjustment.

See also

set_vadjustment().

Friends And Related Function Documentation

Glib::RefPtr< Gtk::Scrollable > wrap ( GtkScrollable *  object, bool  take_copy = false  )

related

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

Parameters

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.

Returns

A C++ instance that wraps this C instance.