Maeomm Reference Documentation: hildonsmm
Main Page   Namespaces   Book  

Hildon::WindowStack Class Reference

Inheritance diagram for Hildon::WindowStack:

Inheritance graph
[legend]

List of all members.


Detailed Description

Object representing a stack of windows in the Hildon framework.

The Hildon::WindowStack is an object used to represent a stack of windows in the Hildon framework.

Stacks contain all Hildon::StackableWindows that are being shown. The user can only interact with the topmost window from each stack (as it covers all the others), but all of them are mapped and visible from the GTK+ point of view.

Each window can only be in one stack at a time. All stacked windows are visible and all visible windows are stacked. Each application has a default stack, and windows are automatically added to it when they are shown with Gtk::Widget::show().

Additional stacks can be created at any time using Hildon::WindowStack::create(). To add a window to a specific stack, use Hildon::WindowStack::push() (remember that, for the default stack, Gtk::Widget::show() can be used instead).

To remove a window from a stack use Hildon::WindowStack::pop(), or simply Gtk::Widget::hide().

For more complex layout changes, applications can push and/or pop several windows at the same time in a single step. See Hildon::WindowStack::push(), Hildon::WindowStack::pop() and Hildon::WindowStack::pop_and_push() for more details.

Public Member Functions

bool empty () const
const HildonWindowStack* gobj () const
 Provides access to the underlying C GObject.
HildonWindowStack* gobj ()
 Provides access to the underlying C GObject.
HildonWindowStack* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::ListHandle
<StackableWindow*> 
pop (int nwindows)
StackableWindowpop ()
Glib::ListHandle
<StackableWindow*> 
pop_and_push (int nwindows, const Glib::ListHandle<StackableWindow*>& list)
void push (const Glib::ListHandle<StackableWindow*>& list)
void push (StackableWindow* win)
int size () const
StackableWindowtop () const
virtual ~WindowStack ()

Static Public Member Functions

static Glib::RefPtr<WindowStackcreate ()
static Glib::RefPtr<WindowStackget_default ()

Protected Member Functions

 WindowStack ()

Related Functions

(Note that these are not member functions.)

Glib::RefPtr<Hildon::WindowStackwrap (HildonWindowStack* object, bool take_copy=false)
 A Glib::wrap() method for this object.


Constructor & Destructor Documentation

virtual Hildon::WindowStack::~WindowStack (  )  [virtual]

Hildon::WindowStack::WindowStack (  )  [protected]


Member Function Documentation

static Glib::RefPtr<WindowStack> Hildon::WindowStack::create (  )  [static]

bool Hildon::WindowStack::empty (  )  const

static Glib::RefPtr<WindowStack> Hildon::WindowStack::get_default (  )  [static]

const HildonWindowStack* Hildon::WindowStack::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

HildonWindowStack* Hildon::WindowStack::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

HildonWindowStack* Hildon::WindowStack::gobj_copy (  ) 

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

Glib::ListHandle<StackableWindow*> Hildon::WindowStack::pop ( int  nwindows  ) 

StackableWindow* Hildon::WindowStack::pop (  ) 

Glib::ListHandle<StackableWindow*> Hildon::WindowStack::pop_and_push ( int  nwindows,
const Glib::ListHandle<StackableWindow*>&  list 
)

void Hildon::WindowStack::push ( const Glib::ListHandle<StackableWindow*>&  list  ) 

void Hildon::WindowStack::push ( StackableWindow win  ) 

int Hildon::WindowStack::size (  )  const

StackableWindow* Hildon::WindowStack::top (  )  const


Friends And Related Function Documentation

Glib::RefPtr<Hildon::WindowStack> wrap ( HildonWindowStack *  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 for hildonmm by Doxygen 1.5.6 © 1997-2001