![]() |
![]() |
This container accepts a single child widget. It adds scrollbars to the child widget and optionally draws a beveled frame around the child widget. The scrolled window can work in two ways: 1) Some widgets have native scrolling support; these widgets handle certain Gtk::Adjustment signals. Widgets with native scroll support include Gtk::TreeView, Gtk::TextView, and Gtk::Layout. 2) For widgets that lack native scrolling support, such as Gtk::Table, Gtk::Box, and so on, the widget will be placed inside a Gtk::Viewport.
The position of the scrollbars is controlled by the scroll adjustments. See Gtk::Adjustment for the fields in an adjustment - for Gtk::Scrollbar, used by Gtk::ScrolledWindow, the "value" field represents the position of the scrollbar, which must be between the "lower" field and "upper - page_size." The "page_size" field represents the size of the visible scrollable area. The "step_increment" and "page_increment" fields are used when the user asks to step down (using the small stepper arrows) or page down (using for example the PageDown key).
If a Gtk::ScrolledWindow doesn't behave quite as you would like, or doesn't have exactly the right layout, it's very possible to set up your own scrolling with Gtk::Scrollbar and, for example, a Gtk::Table.
Public Member Functions | ||||
virtual void | add (Gtk::Widget& widget) | |||
Puts the child inside a Gtk::Viewport if it doesn't have native scrolling capability. | ||||
const Gtk::Adjustment* | get_hadjustment () const | |||
Gtk::Adjustment* | get_hadjustment () | |||
const Gtk::HScrollbar* | get_hscrollbar () const | |||
Gtk::HScrollbar* | get_hscrollbar () | |||
bool | get_hscrollbar_visible () const | |||
CornerType | get_placement () const | |||
Gets the placement of the scrollbars for the scrolled window. | ||||
void | get_policy (PolicyType& hscrollbar_policy, PolicyType& vscrollbar_policy) const | |||
Retrieves the current policy values for the horizontal and vertical scrollbars. | ||||
ShadowType | get_shadow_type () const | |||
Gets the shadow type of the scrolled window. | ||||
const Gtk::Adjustment* | get_vadjustment () const | |||
Gtk::Adjustment* | get_vadjustment () | |||
const Gtk::VScrollbar* | get_vscrollbar () const | |||
Gtk::VScrollbar* | get_vscrollbar () | |||
bool | get_vscrollbar_visible () const | |||
const GtkScrolledWindow* | gobj () const | |||
Provides access to the underlying C GtkObject. | ||||
GtkScrolledWindow* | gobj () | |||
Provides access to the underlying C GtkObject. | ||||
ScrolledWindow (Adjustment& hadjustment, Adjustment& vadjustment) | ||||
ScrolledWindow () | ||||
void | set_hadjustment (Gtk::Adjustment& hadjustment) | |||
void | set_hadjustment (Gtk::Adjustment* hadjustment=0) | |||
void | set_placement (CornerType window_placement) | |||
void | set_policy (PolicyType hscrollbar_policy, PolicyType vscrollbar_policy) | |||
void | set_shadow_type (ShadowType type) | |||
Changes the type of shadow drawn around the contents of scrolled_window . | ||||
void | set_vadjustment (Gtk::Adjustment& vadjustment) | |||
void | set_vadjustment (Gtk::Adjustment* vadjustment=0) | |||
virtual | ~ScrolledWindow () | |||
Related Functions | ||||
(Note that these are not member functions.) | ||||
Gtk::ScrolledWindow* | wrap (GtkScrolledWindow* object, bool take_copy=false) | |||
|
virtual Gtk::ScrolledWindow::~ScrolledWindow | ( | ) | [virtual] |
Gtk::ScrolledWindow::ScrolledWindow | ( | ) |
Gtk::ScrolledWindow::ScrolledWindow | ( | Adjustment& | hadjustment, | |
Adjustment& | vadjustment | |||
) | [explicit] |
virtual void Gtk::ScrolledWindow::add | ( | Gtk::Widget& | widget | ) | [virtual] |
Puts the child inside a Gtk::Viewport if it doesn't have native scrolling capability.
Reimplemented from Gtk::Container.
const Gtk::Adjustment* Gtk::ScrolledWindow::get_hadjustment | ( | ) | const |
Gtk::Adjustment* Gtk::ScrolledWindow::get_hadjustment | ( | ) |
const Gtk::HScrollbar* Gtk::ScrolledWindow::get_hscrollbar | ( | ) | const |
Gtk::HScrollbar* Gtk::ScrolledWindow::get_hscrollbar | ( | ) |
bool Gtk::ScrolledWindow::get_hscrollbar_visible | ( | ) | const |
CornerType Gtk::ScrolledWindow::get_placement | ( | ) | const |
Gets the placement of the scrollbars for the scrolled window.
See set_placement().
void Gtk::ScrolledWindow::get_policy | ( | PolicyType& | hscrollbar_policy, | |
PolicyType& | vscrollbar_policy | |||
) | const |
Retrieves the current policy values for the horizontal and vertical scrollbars.
See set_policy().
hscrollbar_policy | Location to store the policy for the horizontal scrollbar, or 0 . | |
vscrollbar_policy | Location to store the policy for the horizontal scrollbar, or 0 . |
ShadowType Gtk::ScrolledWindow::get_shadow_type | ( | ) | const |
Gets the shadow type of the scrolled window.
See set_shadow_type().
const Gtk::Adjustment* Gtk::ScrolledWindow::get_vadjustment | ( | ) | const |
Gtk::Adjustment* Gtk::ScrolledWindow::get_vadjustment | ( | ) |
const Gtk::VScrollbar* Gtk::ScrolledWindow::get_vscrollbar | ( | ) | const |
Gtk::VScrollbar* Gtk::ScrolledWindow::get_vscrollbar | ( | ) |
bool Gtk::ScrolledWindow::get_vscrollbar_visible | ( | ) | const |
const GtkScrolledWindow* Gtk::ScrolledWindow::gobj | ( | ) | const [inline] |
GtkScrolledWindow* Gtk::ScrolledWindow::gobj | ( | ) | [inline] |
void Gtk::ScrolledWindow::set_hadjustment | ( | Gtk::Adjustment& | hadjustment | ) |
void Gtk::ScrolledWindow::set_hadjustment | ( | Gtk::Adjustment* | hadjustment = 0 |
) |
void Gtk::ScrolledWindow::set_placement | ( | CornerType | window_placement | ) |
void Gtk::ScrolledWindow::set_policy | ( | PolicyType | hscrollbar_policy, | |
PolicyType | vscrollbar_policy | |||
) |
void Gtk::ScrolledWindow::set_shadow_type | ( | ShadowType | type | ) |
Changes the type of shadow drawn around the contents of scrolled_window .
type | Kind of shadow to draw around scrolled window contents. |
void Gtk::ScrolledWindow::set_vadjustment | ( | Gtk::Adjustment& | vadjustment | ) |
void Gtk::ScrolledWindow::set_vadjustment | ( | Gtk::Adjustment* | vadjustment = 0 |
) |
Gtk::ScrolledWindow* wrap | ( | GtkScrolledWindow * | object, | |
bool | take_copy = false | |||
) | [related] |
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. |