- Your Widget Set For OpenGL
Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | Related Pages

ufo::UInternalFrame Class Reference

An internal frame, contains a root pane and optional a menubar. More...

#include <uinternalframe.hpp>

Inheritance diagram for ufo::UInternalFrame:

ufo::UWidget ufo::UObject ufo::UCollectable List of all members.

Public Member Functions

 UInternalFrame ()
 UInternalFrame (const std::string &title)
 UInternalFrame (uint32_t frameStyle)
 UInternalFrame (const std::string &title, uint32_t frameStyle)
virtual URootPane * getRootPane () const
virtual UWidget * getContentPane () const
virtual ULayeredPane * getLayeredPane () const
virtual void setTitle (const std::string &title)
virtual std::string getTitle ()
virtual void pack ()
FrameStyle getFrameStyle () const
void setFrameStyle (int frameStyle)
FrameState getFrameState () const
void setFrameState (int frameState)
void maximize ()
bool isMaximized () const
void minimize ()
bool isMinimized () const
void restore ()
virtual void setResizable (bool b)
bool isResizable () const
virtual bool isActive () const
virtual UDimension getContentsSize (const UDimension &maxSize) const
virtual void processMouseEvent (UMouseEvent *e)
virtual void processWidgetEvent (UWidgetEvent *e)
virtual void processStateChangeEvent (uint32_t state)

Protected Member Functions

UDesktopPane * getDesktopPane ()

Protected Attributes

UDesktopPane * m_desktop
URootPane * m_rootPane
std::string m_title
uint32_t m_frameStyle
uint32_t m_frameState
URectangle m_restoreBounds

Detailed Description

An internal frame, contains a root pane and optional a menubar.

Author:
Johannes Schmidt


Constructor & Destructor Documentation

ufo::UInternalFrame::UInternalFrame (   ) 
 

Creates a closable internal frame.

ufo::UInternalFrame::UInternalFrame (  const std::string &  title  ) 
 

Creates a closable internal frame with the given title.

Parameters:
title The frame caption

ufo::UInternalFrame::UInternalFrame (  uint32_t  frameStyle  ) 
 

Creates an internal frame with the given frame style.

Parameters:
frameStyle The frame style (closable, resizable, ...)
See also:
FrameStyle

ufo::UInternalFrame::UInternalFrame (  const std::string &  title,
uint32_t  frameStyle
) 
 

Creates an internal frame with the given title and given frame style.

Parameters:
title The frame caption
See also:
FrameStyle


Member Function Documentation

virtual UWidget* ufo::UInternalFrame::getContentPane (   )  const [virtual]
 

Returns:
The content pane object for this frame

virtual ULayeredPane* ufo::UInternalFrame::getLayeredPane (   )  const [virtual]
 

Returns:
the layered pane object for this frame

virtual URootPane* ufo::UInternalFrame::getRootPane (   )  const [virtual]
 

Returns:
The root pane object for this frame

virtual bool ufo::UInternalFrame::isActive (   )  const [virtual]
 

Returns true if this frame is the top most frame.

Reimplemented from ufo::UWidget.

void ufo::UInternalFrame::maximize (   ) 
 

Maximizes this internal frame to parents root pane size.

virtual void ufo::UInternalFrame::pack (   )  [virtual]
 

sets the frame size to the preferred size. computes the preferred size of the root pane and resizes the frame to the correct size.

virtual void ufo::UInternalFrame::processMouseEvent (  UMouseEvent *  e  )  [virtual]
 

Processes focus events. Primarily, it is used to notify listeners.

Reimplemented from ufo::UWidget.

virtual void ufo::UInternalFrame::processWidgetEvent (  UWidgetEvent *  e  )  [virtual]
 

Processes widget events. Primarily, it is used to notify listeners.

Reimplemented from ufo::UWidget.

void ufo::UInternalFrame::restore (   ) 
 

Restores this internal frame to its size before maximizing or minimizing or does nothing.

void ufo::UInternalFrame::setFrameState (  int  frameState  ) 
 

Tries to change the frame state. You should check with getFrameState whether it was succesful.

virtual void ufo::UInternalFrame::setResizable (  bool  b  )  [virtual]
 

Sets whether this frame is resizable. Default is false. Not yet implemented


Member Data Documentation

URootPane* ufo::UInternalFrame::m_rootPane [protected]
 

the root pane object


The documentation for this class was generated from the following file:
The libUFO Project - written by Johannes Schmidt