Google

logo top
Main Page   Widgets   Namespaces   Book  

Gtk::Layout Class Reference
[WidgetsContainer Widgets]

Infinite scrollable area containing child widgets and/or custom drawing. More...

Inheritance diagram for Gtk::Layout:

Inheritance graph
[legend]
List of all members.

Public Methods

virtual ~Layout ()
GtkLayout* gobj ()
const GtkLayout* gobj () const
 Layout ()
 Layout (Adjustment& hadjustment, Adjustment& vadjustment)
void put (Widget& widget, int x, int y)
 Adds child_widget to layout , at position ( x , y ).

void move (Widget& widget, int x, int y)
 Moves a current child of layout to a new position.

void set_size (guint width, guint height)
 Sets the size of the scrollable area of the layout.

void get_size (guint& width, guint& height) const
 Gets the size that has been set on the layout, and that determines the total extents of the layout's scrollbar area.

void set_hadjustment (Adjustment& hadj)
 Sets the horizontal scroll adjustment for the layout.

void set_hadjustment ()
 Creates the Adjustment.

Adjustmentget_hadjustment ()
 This function should only be called after the layout has been placed in a Gtk::ScrolledWindow or otherwise configured for scrolling.

const Adjustmentget_hadjustment () const
 This function should only be called after the layout has been placed in a Gtk::ScrolledWindow or otherwise configured for scrolling.

void set_vadjustment (Adjustment& vadj)
 Sets the vertical scroll adjustment for the layout.

void set_vadjustment ()
 Creates the Adjustment.

Adjustmentget_vadjustment ()
 This function should only be called after the layout has been placed in a Gtk::ScrolledWindow or otherwise configured for scrolling.

const Adjustmentget_vadjustment () const
 This function should only be called after the layout has been placed in a Gtk::ScrolledWindow or otherwise configured for scrolling.

Glib::RefPtr<Gdk::Windowget_bin_window ()
Glib::RefPtr<const Gdk::Windowget_bin_window () const
Glib::SignalProxy2< void,
Adjustment*, Adjustment* > 
signal_set_scroll_adjustments ()
Glib::PropertyProxy<Adjustment*> property_hadjustment ()
Glib::PropertyProxy<Adjustment*> property_vadjustment ()
Glib::PropertyProxy<guint> property_width ()
Glib::PropertyProxy<guint> property_height ()

Protected Methods

virtual void on_set_scroll_adjustments (Adjustment* p1, Adjustment* p2)

Related Functions

(Note that these are not member functions.)

Gtk::Layout* wrap (GtkLayout* object, bool take_copy=false)

Detailed Description

Infinite scrollable area containing child widgets and/or custom drawing.

Gtk::Layout is similar to Gtk::DrawingArea in that it's a "blank slate" and doesn't do anything but paint a blank background by default. It's different in that it supports scrolling natively (You can add it directly to a Gtk::ScrolledWindow), and it can contain child widgets, since it's a Gtk::Container. However if you're just going to draw, a Gtk::DrawingArea is a better choice since it has lower overhead.

When handling expose_event signals, you must draw to the bin_window Gdk::Window - see get_bin_window() - rather than the normal Gdk::Window - see get_window() - as you would for a drawing area.


Constructor & Destructor Documentation

virtual Gtk::Layout::~Layout (   [virtual]
 

Gtk::Layout::Layout (  
 

Gtk::Layout::Layout ( Adjustment   hadjustment,
Adjustment   vadjustment
 


Member Function Documentation

Glib::RefPtr<const Gdk::Window> Gtk::Layout::get_bin_window (   const
 

Glib::RefPtr<Gdk::Window> Gtk::Layout::get_bin_window (  
 

const Adjustment* Gtk::Layout::get_hadjustment (   const
 

This function should only be called after the layout has been placed in a Gtk::ScrolledWindow or otherwise configured for scrolling.

It returns the Gtk::Adjustment used for communication between the horizontal scrollbar and layout .

See Gtk::ScrolledWindow, Gtk::Scrollbar, Gtk::Adjustment for details.

Returns:
Horizontal scroll adjustment.

Adjustment* Gtk::Layout::get_hadjustment (  
 

This function should only be called after the layout has been placed in a Gtk::ScrolledWindow or otherwise configured for scrolling.

It returns the Gtk::Adjustment used for communication between the horizontal scrollbar and layout .

See Gtk::ScrolledWindow, Gtk::Scrollbar, Gtk::Adjustment for details.

Returns:
Horizontal scroll adjustment.

void Gtk::Layout::get_size ( guint&    width,
guint&    height
const
 

Gets the size that has been set on the layout, and that determines the total extents of the layout's scrollbar area.

See set_size().

Parameters:
width Location to store the width set on layout , or 0.
height Location to store the height set on layout , or 0.

const Adjustment* Gtk::Layout::get_vadjustment (   const
 

This function should only be called after the layout has been placed in a Gtk::ScrolledWindow or otherwise configured for scrolling.

It returns the Gtk::Adjustment used for communication between the vertical scrollbar and layout .

See Gtk::ScrolledWindow, Gtk::Scrollbar, Gtk::Adjustment for details.

Returns:
Vertical scroll adjustment.

Adjustment* Gtk::Layout::get_vadjustment (  
 

This function should only be called after the layout has been placed in a Gtk::ScrolledWindow or otherwise configured for scrolling.

It returns the Gtk::Adjustment used for communication between the vertical scrollbar and layout .

See Gtk::ScrolledWindow, Gtk::Scrollbar, Gtk::Adjustment for details.

Returns:
Vertical scroll adjustment.

const GtkLayout* Gtk::Layout::gobj (   const [inline]
 

Reimplemented from Gtk::Container.

GtkLayout* Gtk::Layout::gobj (   [inline]
 

Reimplemented from Gtk::Container.

void Gtk::Layout::move ( Widget   widget,
int    x,
int    y
 

Moves a current child of layout to a new position.

Parameters:
child_widget A current child of layout .
x X position to move to.
y Y position to move to.

virtual void Gtk::Layout::on_set_scroll_adjustments ( Adjustment   p1,
Adjustment   p2
[protected, virtual]
 

Glib::PropertyProxy<Adjustment*> Gtk::Layout::property_hadjustment (  
 

Glib::PropertyProxy<guint> Gtk::Layout::property_height (  
 

Glib::PropertyProxy<Adjustment*> Gtk::Layout::property_vadjustment (  
 

Glib::PropertyProxy<guint> Gtk::Layout::property_width (  
 

void Gtk::Layout::put ( Widget   widget,
int    x,
int    y
 

Adds child_widget to layout , at position ( x , y ).

layout becomes the new parent container of child_widget .

Parameters:
child_widget Child widget.
x X position of child widget.
y Y position of child widget.

void Gtk::Layout::set_hadjustment (  
 

Creates the Adjustment.

void Gtk::Layout::set_hadjustment ( Adjustment   hadj
 

Sets the horizontal scroll adjustment for the layout.

See Gtk::ScrolledWindow, Gtk::Scrollbar, Gtk::Adjustment for details.

Parameters:
adjustment New scroll adjustment.

void Gtk::Layout::set_size ( guint    width,
guint    height
 

Sets the size of the scrollable area of the layout.

Parameters:
width Width of entire scrollable area.
height Height of entire scrollable area.

void Gtk::Layout::set_vadjustment (  
 

Creates the Adjustment.

void Gtk::Layout::set_vadjustment ( Adjustment   vadj
 

Sets the vertical scroll adjustment for the layout.

See Gtk::ScrolledWindow, Gtk::Scrollbar, Gtk::Adjustment for details.

Parameters:
adjustment New scroll adjustment.

Glib::SignalProxy2<void,Adjustment*,Adjustment*> Gtk::Layout::signal_set_scroll_adjustments (  
 

Prototype:
void set_scroll_adjustments(Adjustment* p1, Adjustment* p2)


Friends And Related Function Documentation

Gtk::Layout* wrap ( GtkLayout*    object,
bool    take_copy = false
[related]
 


The documentation for this class was generated from the following file:
Generated for gtkmm by Doxygen 1.3-rc1 © 1997-2001