Functions
PUGL_API PuglStatus	puglSetWindowTitle (PuglView view, const char title)
PUGL_API const char *	puglGetWindowTitle (const PuglView *view)
	Return the title of the window, or null.
PUGL_API PuglStatus	puglSetParentWindow (PuglView *view, PuglNativeView parent)
PUGL_API PuglNativeView	puglGetParentWindow (const PuglView *view)
	Return the parent window this view is embedded in, or null.
PUGL_API PuglStatus	puglSetTransientParent (PuglView *view, PuglNativeView parent)
PUGL_API PuglNativeView	puglGetTransientParent (const PuglView *view)
PUGL_API PuglStatus	puglRealize (PuglView *view)
PUGL_API PuglStatus	puglShow (PuglView *view)
PUGL_API PuglStatus	puglHide (PuglView *view)
	Hide the current window.
PUGL_API bool	puglGetVisible (const PuglView *view)
	Return true iff the view is currently visible.
PUGL_API PuglNativeView	puglGetNativeView (PuglView *view)
	Return the native window handle.

Detailed Description

Functions to control the top-level window of a view.

Function Documentation

◆ puglGetNativeView()

PUGL_API PuglNativeView puglGetNativeView ( PuglView * view )

Return the native window handle.

◆ puglGetParentWindow()

PUGL_API PuglNativeView puglGetParentWindow ( const PuglView * view )

Return the parent window this view is embedded in, or null.

◆ puglGetTransientParent()

PUGL_API PuglNativeView puglGetTransientParent ( const PuglView * view )

Return the transient parent of the window.

Returns: The native handle to the window this view is a transient child of, or null.

◆ puglGetVisible()

PUGL_API bool puglGetVisible ( const PuglView * view )

Return true iff the view is currently visible.

◆ puglGetWindowTitle()

PUGL_API const char * puglGetWindowTitle ( const PuglView * view )

Return the title of the window, or null.

◆ puglHide()

PUGL_API PuglStatus puglHide ( PuglView * view )

Hide the current window.

◆ puglRealize()

PUGL_API PuglStatus puglRealize ( PuglView * view )

Realize a view by creating a corresponding system view or window.

After this call, the (initially invisible) underlying system view exists and can be accessed with puglGetNativeView(). There is currently no corresponding unrealize function, the system view will be destroyed along with the view when puglFreeView() is called.

The view should be fully configured using the above functions before this is called. This function may only be called once per view.

◆ puglSetParentWindow()

PUGL_API PuglStatus puglSetParentWindow	(	PuglView *	view,
		PuglNativeView	parent )

Set the parent window for embedding a view in an existing window.

This must be called before puglRealize(), reparenting is not supported.

◆ puglSetTransientParent()

PUGL_API PuglStatus puglSetTransientParent	(	PuglView *	view,
		PuglNativeView	parent )

Set the transient parent of the window.

Set this for transient children like dialogs, to have them properly associated with their parent window. This should be called before puglRealize().

A view can either have a parent (for embedding) or a transient parent (for top-level windows like dialogs), but not both.

◆ puglSetWindowTitle()

PUGL_API PuglStatus puglSetWindowTitle	(	PuglView *	view,
		const char *	title )

Set the title of the window.

This only makes sense for non-embedded views that will have a corresponding top-level window, and sets the title, typically displayed in the title bar or in window switchers.

◆ puglShow()

PUGL_API PuglStatus puglShow ( PuglView * view )

Show the view.

If the view has not yet been realized, the first call to this function will do so automatically.

If the view is currently hidden, it will be shown and possibly raised to the top depending on the platform.