Clutter::Gtk::Viewport Class Reference

This is a scrollable actor that can contain a single Clutter::Actor. More...

Inherits Clutter::Actor.

Collaboration diagram for Clutter::Gtk::Viewport:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~Viewport ()
GtkClutterViewport* gobj ()
 Provides access to the underlying C GObject.
const GtkClutterViewport* gobj () const
 Provides access to the underlying C GObject.
GtkClutterViewport* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void get_origin (float& x, float& y, float& z) const
 Retrieves the current translation factor ("origin") used when displaying the child of viewport.

Static Public Member Functions

static Glib::RefPtr< Viewportcreate (::Gtk::Adjustment* h_adjustment=0,::Gtk::Adjustment* v_adjustment=0,::Gtk::Adjustment* z_adjustment=0)

Protected Member Functions

 Viewport (::Gtk::Adjustment* h_adjustment=0,::Gtk::Adjustment* v_adjustment=0,::Gtk::Adjustment* z_adjustment=0)

Related Functions

(Note that these are not member functions.)



Glib::RefPtr
< Clutter::Gtk::Viewport
wrap (GtkClutterViewport* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

This is a scrollable actor that can contain a single Clutter::Actor.

Using two Gtk::Adjustments it is possible to control the visible area of the child actor if the size of the viewport is smaller than the size of the child.

The Gtk::Adjustments used to control the horizontal and vertical scrolling can be attached to a Gtk::Scrollbar subclass, like Gtk::HScrollbar or Gtk::VScrollbar.

The Viewport can be used inside any Clutter::Container implementation.


Constructor & Destructor Documentation

virtual Clutter::Gtk::Viewport::~Viewport (  )  [virtual]
Clutter::Gtk::Viewport::Viewport ( ::Gtk::Adjustment h_adjustment = 0,
::Gtk::Adjustment v_adjustment = 0,
::Gtk::Adjustment z_adjustment = 0 
) [explicit, protected]

Member Function Documentation

static Glib::RefPtr<Viewport> Clutter::Gtk::Viewport::create ( ::Gtk::Adjustment h_adjustment = 0,
::Gtk::Adjustment v_adjustment = 0,
::Gtk::Adjustment z_adjustment = 0 
) [static]
void Clutter::Gtk::Viewport::get_origin ( float &  x,
float &  y,
float &  z 
) const

Retrieves the current translation factor ("origin") used when displaying the child of viewport.

Since clutter-gtkmm 1.0:
Parameters:
x Return location for the X origin in pixels, or 0.
y Return location for the Y origin in pixels, or 0.
z Return location for the Z origin in pixels, or 0.
const GtkClutterViewport* Clutter::Gtk::Viewport::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Clutter::Actor.

GtkClutterViewport* Clutter::Gtk::Viewport::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Clutter::Actor.

GtkClutterViewport* Clutter::Gtk::Viewport::gobj_copy (  ) 

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Reimplemented from Clutter::Actor.


Friends And Related Function Documentation

Glib::RefPtr< Clutter::Gtk::Viewport > wrap ( GtkClutterViewport *  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.

The documentation for this class was generated from the following file:

Generated on Wed May 5 23:47:15 2010 for clutter-gtkmm by  doxygen 1.6.1