Layout Containers

From CEGUI Wiki - Crazy Eddie's GUI System (Open Source)
Jump to: navigation, search

Written for CEGUI 0.8

Works with versions 0.8.x (stable)

Works with latest CEGUI stable!

This introduces the concept of widgets that automatically layout their child widgets. Without these layout containers, doing dynamic complex UI was really hard and you had to do a lot of custom code.

Basic concepts

Layout containers are simply widgets that have no visuals to them, they don't render anything, they also usually don't react to any input (this isn't really required but the 3 existing stock layout containers don't react to input themselves). They simply just set their child windows positions in a certain way (depending on the container). When child windows are resized, added or removed, the layout containers relayouts them to match the arrangement.

Inbuilt layout containers

Vertical Layout Container

Arranges child windows one after each other vertically.

Code sample:

CEGUI::VerticalLayoutContainer* layout = static_cast<CEGUI::VerticalLayoutContainer*>(CEGUI::WindowManager::getSingleton().createWindow("VerticalLayoutContainer"));
// add windows to the layout

Horizontal Layout Container

Arranges child windows one after each other horizontally.

Horizontal layout container is used exactly the same as vertical layout container.

Grid Layout Container

Arranges child windows into a grid. You have to set grid dimensions before you add any windows to the container.

Basic Example:

// includes: <sstream>, loaded schemes: TaharezLook.scheme
CEGUI::GridLayoutContainer *glc = static_cast<CEGUI::GridLayoutContainer*>(CEGUI::WindowManager::getSingletonPtr()->createWindow("GridLayoutContainer", "GLC"));
d_root->addChild( glc );
glc->setGridDimensions( 2, 3 );
for(int i = 0; i < 6; ++i)
    std::stringstream stringStream;
    stringStream << "Window #" << i;
    CEGUI::Window* window = CEGUI::WindowManager::getSingletonPtr()->createWindow( 
    window->setSize( CEGUI::USize( cegui_reldim( 0.1f ), cegui_reldim( 0.1f )));
    glc->addChild( window );