Container

Detailed Description

Basic container.

A Container is a GWindow that supports child windows. It is also a widget in its own right and therefore can accept user input directly.

Precondition

GFX_USE_GWIN and GWIN_NEED_CONTAINERS must be set to GFXON in your gfxconf.h

Modules
	Renderings
	Built-in rendering functions for the container widget.

Functions
GHandle	gwinGetFirstChild (GHandle gh)
	Get the first child window. More...
GHandle	gwinGetSibling (GHandle gh)
	Get the next child window in the z-order. More...
gCoord	gwinGetInnerWidth (GHandle gh)
	Get the inner width of a container window. More...
gCoord	gwinGetInnerHeight (GHandle gh)
	Get the inner height of a container window. More...
GHandle	gwinGContainerCreate (GDisplay *g, GContainerObject *gw, const GWidgetInit *pInit, gU32 flags)
	Create a simple container. More...
typedef GWidgetObject	GContainerObject
	The GWIN Container structure. More...
#define	GWIN_CONTAINER_BORDER   0x00000001
	Flags for gwinContainerCreate() More...

Function Documentation

gwinGContainerCreate()

GHandle gwinGContainerCreate	(	GDisplay *	g,
		GContainerObject *	gw,
		const GWidgetInit *	pInit,
		gU32	flags
	)

Create a simple container.

Returns

NULL if there is no resultant drawing area, otherwise a window handle.

Parameters

[in]	g	The GDisplay to display this window on
[in]	gw	The GContainerObject structure to initialise. If this is NULL the structure is dynamically allocated.
[in]	pInit	The initialisation parameters
[in]	flags	Some flags, see notes

Function Class: Normal API, this function can be invoked by regular system threads.

gwinGetFirstChild()

GHandle gwinGetFirstChild

(

GHandle

gh

)

Get the first child window.

A comment/rant on the above structure: We would really like the GWidgetObject member to be anonymous. While this is allowed under the C11, C99, GNU and various other standards which have been around forever - compiler support often requires special flags e.g gcc requires the -fms-extensions flag (no wonder the language and compilers have not really progressed in 30 years). As portability is a key requirement we unfortunately won't use this useful feature in case we get a compiler that won't support it even with special flags.

Returns

The first child or NULL if are no children windows

Parameters

[in]

gh

The parent container or NULL to get the first top level window

Function Class: Normal API, this function can be invoked by regular system threads.

gwinGetInnerHeight()

gCoord gwinGetInnerHeight

(

GHandle

gh

)

Get the inner height of a container window.

Returns

The inner height of a container window or zero if this is not a container

Parameters

[in]

gh

The window

Function Class: Normal API, this function can be invoked by regular system threads.

gwinGetInnerWidth()

gCoord gwinGetInnerWidth

(

GHandle

gh

)

Get the inner width of a container window.

Returns

The inner width of a container window or zero if this is not a container

Parameters

[in]

gh

The window

Function Class: Normal API, this function can be invoked by regular system threads.

gwinGetSibling()

GHandle gwinGetSibling

(

GHandle

gh

)

Get the next child window in the z-order.

Returns

The next window or NULL if no more children

Parameters

[in]

gh

The window to obtain the next sibling of.

Note

This returns the next window under the current parent window. Unlike gwinGetNextWindow() it will only return windows that have the same parent as the supplied window.

Function Class: Normal API, this function can be invoked by regular system threads.

Macro Definition Documentation

GWIN_CONTAINER_BORDER

#define GWIN_CONTAINER_BORDER   0x00000001

Flags for gwinContainerCreate()

Definition at line 102 of file gwin_container.h.

Typedef Documentation

GContainerObject

typedef GWidgetObject GContainerObject

The GWIN Container structure.

Note

A container is a GWIN widget that can have children.

Do not access the members directly. Treat it as a black-box and use the method functions.

Definition at line 35 of file gwin_container.h.