ULForegroundPanelDesc

#include <AppCore/CAPI/CAPI_Layout.h>

Overview

Options for creating a foreground (floating) panel.

A zero-initialized desc creates an unkeyed, full-window floating panel.

See also

ulForegroundAddPanel()

Public Attributes
uint32_t	struct_size
	Must be sizeof(ULForegroundPanelDesc).
const char *	key
	Optional identity for lookup and diagnostics (see ULPanelDesc.key).
ULLayoutSize	width
	The panel's width.
ULLayoutSize	height
	The panel's height (see width, percent of the window's height).
ULAnchorDesc	placement
	Where the panel sits in the window. Zero-initialized means the window origin.
unsigned char	dismiss
	The auto-dismiss policy, as a ULDismiss value (see <AppCore/CAPI.h>).
unsigned char	focus
	The keyboard-focus policy, as a ULFocusPolicy value. (Default = kULFocusPolicy_Auto).
uint32_t	flags
	A ULLayoutFlags combination: Hidden.

Member Data Documentation

dismiss

unsigned char dismiss

The auto-dismiss policy, as a ULDismiss value (see <AppCore/CAPI.h>).

kULDismiss_Auto hides the panel the way native menus close (a press outside it, Esc, a window move/resize/deactivation), firing its dismiss callbacks. The closing press is consumed. (Default = kULDismiss_Manual)

flags

uint32_t flags

A ULLayoutFlags combination: Hidden.

focus

unsigned char focus

The keyboard-focus policy, as a ULFocusPolicy value. (Default = kULFocusPolicy_Auto).

height

ULLayoutSize height

The panel's height (see width, percent of the window's height).

key

const char* key

Optional identity for lookup and diagnostics (see ULPanelDesc.key).

placement

ULAnchorDesc placement

Where the panel sits in the window. Zero-initialized means the window origin.

struct_size

uint32_t struct_size

Must be sizeof(ULForegroundPanelDesc).

width

ULLayoutSize width

The panel's width.

Percent means percent of the window's width. A flex factor is treated as unset with a warning. Unset means 100%.

---

The documentation for this struct was generated from the following file:

• AppCore/CAPI/CAPI_Layout.h