Draggable and resizable container Views. More...

#include <Panel.h>

Inheritance diagram for Panel:

Public Member Functions
Class *	_Panel (void)
	The Panel archetype.

SDL_Size	contentSize (const Panel *self)

Panel *	initWithFrame (Panel self, const SDL_Rect frame)
	Initializes this Panel with the specified frame and style.

Public Member Functions inherited from Control
Class *	_Control (void)
	The Control archetype.

bool	captureEvent (Control self, const SDL_Event event)
	Captures a given event, potentially altering the state of this Control.

Control	initWithFrame (Control self, const SDL_Rect frame)
	Initializes this Control with the specified frame and style.

bool	isDisabled (const Control *self)

bool	isFocused (const Control *self)

bool	isHighlighted (const Control *self)

bool	isSelected (const Control *self)

void	stateDidChange (Control *self)
	Called when the state of this Control changes.

Public Member Functions inherited from View
Class *	_View (void)
	The View archetype.

bool	acceptsKeyResponder (const View *self)

bool	acceptsTouchResponder (const View *self)

void	addClassName (View self, const char className)
	Adds the given class name to this View.

void	addSubview (View self, View subview)
	Adds a subview to this view, to be drawn above its siblings.

void	addSubviewRelativeTo (View self, View subview, View *other, ViewPosition position)
	Adds a subview to this view, positioned relatively to `other`.

	ancestorWithIdentifier (const View self, const char identifier)

void	applyStyle (View self, const Style style)
	Applies the given Style to this View.

void	applyTheme (View self, const Theme theme)
	Applies the given Theme to this View.

void	applyThemeIfNeeded (View self, const Theme theme)
	Recursively applies the Theme to this View and its subviews.

void	attachStylesheet (View self, SDL_Window window)
	Attaches this View's Stylesheet to the Theme associated with the given window.

void	awakeWithCharacters (View self, const char chars)
	Wakes this View with the given null-terminated JSON C string.

void	awakeWithData (View self, const Data data)
	Wakes this View with the specified JSON Data.

void	awakeWithDictionary (View , const Dictionary )
	Wakes this View with the specified Dictionary.

void	awakeWithResource (View self, const Resource resource)
	Wakes this View with the specified Resource.

void	awakeWithResourceName (View self, const char name)
	Wakes this View with the Resource by the specified name.

void	becomeKeyResponder (View *self)
	Become the key responder in the View hierarchy.

void	becomeTouchResponder (View *self)
	Become the touch responder in the View hierarchy.

bool	bind (View self, const Inlet inlets, const Dictionary *dictionary)
	Performs data binding for the Inlets described in `dictionary`.

SDL_Rect	bounds (const View *self)

void	bringSubviewToFront (View self, View subview)
	Brings the specified subview to the front.

void	clearWarnings (const View *self, WarningType type)
	Clears this View's Warnings matching the given level.

SDL_Rect	clippingFrame (const View *self)

bool	containsPoint (const View self, const SDL_Point point)

int	depth (const View *self)

	descendantWithIdentifier (const View self, const char identifier)

void	detachStylesheet (View self, SDL_Window window)
	Detaches this View's Stylesheet from the Theme associated with the given window.

void	didMoveToWindow (View self, SDL_Window window)
	Informs this View that it has been added to the View hierachy of the given window.

bool	didReceiveEvent (const View self, const SDL_Event event)

void	draw (View self, Renderer renderer)
	Draws this View.

void	emitViewEvent (View *self, ViewEvent code, ident data)
	Emits a ViewEvent originating from this View.

void	enumerate (const View *self, ViewEnumerator enumerator, ident data)

void	enumerate (View *self, ViewEnumerator enumerator, ident data)
	Enumerates this View and its descendants, applying `enumerator` to each.

void	enumerateAdjacent (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates adjacent siblings of this View, applying `enumerator` to each.

void	enumerateAncestors (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all ancestors of this View, applying `enumerator` to each.

void	enumerateDescendants (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all descendants of this View, applying `enumerator` to each.

void	enumerateSelection (View self, const char rule, ViewEnumerator enumerator, ident data)
	Enumerates all Views in the selection matched by `rule`, applying `enumerator` to each.

void	enumerateSiblings (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all siblings of this View, applying `enumerator` to each.

void	enumerateSubviews (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all subviews of this View, applying `enumerator` to each.

void	enumerateSuperview (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates the superview of this View, if any, applying `enumerator` to it.

void	enumerateVisible (const View *self, ViewEnumerator enumerator, ident data)

void	enumerateVisible (View *self, ViewEnumerator enumerator, ident data)
	Enumerates this View and its visible descendants, applying `enumerator` to each.

bool	hasClassName (const View self, cosnt char className)

bool	hasOverflow (const View *self)

View *	hitTest (const View self, const SDL_Point point)
	Performs a hit test against this View and its descendants for the given point.

View *	init (View *self)
	Initializes this View.

View *	initWithFrame (View self, const SDL_Rect frame)
	Initializes this View with the specified frame.

void	invalidateStyle (View *self)
	Invalidates the computed Style for this View and its descendants.

bool	isContainer (const View *self)

bool	isDescendantOfView (const View self, const View view)

bool	isKeyResponder (const View *self)

bool	isTouchResponder (const View *self)

bool	isVisible (const View *self)

void	layoutIfNeeded (View *self)
	Recursively updates the layout of this View and its subviews.

	layoutSubviews (View *self)
	Arranges this View's immediate subviews within its (already final) frame.

void	layoutWithConstraint (View *self, ViewConstraint width, ViewConstraint height)
	Resolves this View's size against the given ViewConstraints, then arranges it.

void	layoutWithSize (View self, const SDL_Size size)
	Resizes this View to the given size, then arranges it.

bool	matchesSelector (const View self, const SimpleSelector simpleSelector)

void	moveToWindow (View self, SDL_Window window)
	Moves this View to the View hierarchy of the given window.

String *	path (const View *self)

void	removeAllClassNames (View *self)
	Removes all class names from this View.

void	removeAllSubviews (View *self)
	Removes all subviews from this View.

void	removeClassName (View self, const char className)
	Removes the given class name to this View.

void	removeFromSuperview (View *self)
	Removes this View from its superview.

void	removeSubview (View self, View subview)
	Removes the given subview from this View.

void	render (View self, Renderer renderer)
	Renders this View using the given renderer.

void	renderDeviceDidReset (View *self)
	Informs this View that the render device has reset.

void	renderDeviceWillReset (View *self)
	Informs this View that the render device will reset.

SDL_Rect	renderFrame (const View *self)

void	replaceSubview (View self, View subview, View *replacement)
	Replaces the specified subview with the given replacement.

void	resignKeyResponder (View *self)
	Resigns key responder priority.

void	resignTouchResponder (View *self)
	Resigns touch responder priority.

void	resize (View self, const SDL_Size size)
	Resizes this View to the specified size.

void	resolve (View self, Outlet outlets)
	Resolves the given Outlets from this View's hierarchy.

void	respondToEvent (View self, const SDL_Event event)
	Responds to the specified event.

Set *	select (View self, const char rule)
	Resolves all descendants (including this View) that match the given Selector rule.

View *	selectFirst (View self, const char rule)
	Resolves the first descendant View that matches the given Selector rule.

void	setNeedsApplyTheme (View *self)
	Marks this View as needing Theme application before it is next drawn.

void	setNeedsLayout (View *self)
	Marks this View as needing layout before it is next drawn.

void	setVisibility (View *self, ViewVisibility visibility)
	Sets this View's visibility.

SDL_Size	size (const View *self)

SDL_Size	sizeThastFills (const View *self)

SDL_Size	sizeThatContains (const View *self)

SDL_Size	sizeThatFills (const View *self)

void	sizeThatFits (const View *self)

SDL_Size	sizeThatSatisfies (View *self, ViewConstraint width, ViewConstraint height)
	Resolves the size this View wants to be, within the offered ViewConstraints.

void	sizeToContain (View *self)
	Resizes this View to contain its subviews.

void	sizeToFill (View *self)
	Resizes this View to fill its superview.

void	sizeToFit (View *self)
	Resizes this View to fit its subviews.

void	sizeToSatisfy (View *self, ViewConstraint width, ViewConstraint height)
	Resizes this View to satisfy the given ViewConstraints.

	subviewWithIdentifier (const View self, const char identifier)

void	updateBindings (View *self, ident data)
	Updates data bindings, prompting the appropriate layout changes.

SDL_Rect	viewport (const View *self)

View *	viewWithCharacters (const char chars, Outlet outlets)
	Instantiates a View initialized with the given null-terminated JSON C string.

View *	viewWithData (const Data data, Outlet outlets)
	Instantiates a View initialized with the contents of `data`.

View *	viewWithDictionary (const Dictionary dictionary, Outlet outlets)
	Instantiates a View initialized with the attributes described in `dictionary`.

View *	viewWithResource (const Resource resource, Outlet outlets)
	Instantiates a View initialized with the JSON data in `resource`.

View *	viewWithResourceName (const char name, Outlet outlets)
	Instantiates a View initialized with the JSON Resource with the specified `name`.

Array *	visibleSubviews (const View *self)

void	warn (View self, ViewWarningType type, const char fmt,...)

void	warn (View self, WarningType level, const char fmt,...)
	Appends a warning for this View.

void	willMoveToWindow (View self, SDL_Window window)
	Informs this View that it will be added to the View hierarchy for the given window.

Data Fields
StackView *	accessoryView
	The optional accessories container.

StackView *	contentView
	The internal container.

Control	control
	The superclass.

bool	isDraggable
	If true, this Panel may be repositioned by the user.

bool	isDragging
	True if the user is repositioning this Panel.

bool	isResizable
	If true, this Panel may be resized by the user.

bool	isResizing
	True if the user is resizing this Panel.

Data Fields inherited from Control
ControlBevel	bevel
	The ControlBevel.

SDL_Color	bevelDarkColor
	The bevel color for the shadowed edges.

SDL_Color	bevelLightColor
	The bevel color for the lit edges.

ControlSelection	selection
	The ControlSelection.

unsigned int	state
	The bit mask of ControlState.

View	view
	The superclass.

Data Fields inherited from View
ViewAlignment	alignment
	The alignment.

int	autoresizingMask
	The ViewAutoresizing bitmask.

SDL_Color	backgroundColor
	The background color.

int	backgroundGradientAngle
	The angle of the background gradient, in degrees, clockwise from south: `0` (the default) fills downwards, `90` to the right, `180` upwards.

SDL_Color	backgroundGradientColor
	The far color of the background gradient, which runs from View::backgroundColor.

SDL_Color	borderColor
	The border color.

int	borderRadius
	The corner radius applied to the background, border and bevel.

int	borderWidth
	The border width.

Set *	classNames
	The class names.

bool	clipsSubviews
	If true, subviews will be clipped to this View's frame.

Style *	computedStyle
	The computed Style of this View.

ViewCornerCut	cornerCut
	The horizontal inset of each corner of the background and border.

char *	identifier
	An optional identifier.

SDL_Size	maxSize
	The maximum size this View may be resized to during layout.

SDL_Size	minSize
	The minimum size this View may be resized to during layout.

bool	needsApplyTheme
	If true, this View will apply the Theme before it is drawn.

bool	needsLayout
	If true, this View will layout its subviews before it is drawn.

View *	nextResponder
	The next responder, or event handler, in the chain.

Object	object
	The superclass.

ViewPadding	padding
	The padding.

ViewPointerEvents	pointerEvents
	Whether this View is the result of a hit test; its subviews always are.

bool	stretch
	Whether this View takes a share of the space its StackView leaves along its axis.

Style *	style
	The element-level Style of this View.

Stylesheet *	stylesheet
	An optional Stylesheet.

Array *	subviews
	The immediate subviews.

View *	superview
	The super View.

ViewController *	viewController
	The ViewController.

ViewVisibility	visibility
	Whether this View is drawn, and contributes to its superview's size.

Array *	warnings
	The Warnings this View generated.

SDL_Window *	window
	The window.

Protected Attributes
PanelInterface *	interface [0]
	The interface type.

Protected Attributes inherited from Control
ControlInterface *	interface [0]
	The interface type.

Protected Attributes inherited from View
ViewInterface *	interface [0]
	The interface type.

Detailed Description

Draggable and resizable container Views.

Remarks: Panels are draggable containers, analagous to windows or dialogs in traditional desktop environments. Panels can optionally be positioned and resized by the user.

Definition at line 47 of file Panel.h.

Member Function Documentation

◆ _Panel()

Class * _Panel ( void )

The Panel archetype.

Returns: The Panel Class.

Definition at line 301 of file Panel.c.

                    {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "Panel",
      .superclass = _Control(),
      .instanceSize = sizeof(Panel),
      .interfaceSize = sizeof(PanelInterface),
      .initialize = initialize,
      .destroy = destroy,
    });
  });
 
  return clazz;
}

◆ contentSize()

SDL_Size contentSize ( const Panel * self )

Parameters

self	The Panel.

Returns: The available content size.

Definition at line 201 of file Panel.c.

                                               {
 
  const View *accessoryView = (View *) self->accessoryView;
  const View *contentView = (View *) self->contentView;
 
  SDL_Size size = $(contentView, sizeThatContains);
 
  if (accessoryView->visibility != ViewVisibilityHidden) {
    const SDL_Size accessorySize = $(accessoryView, sizeThatContains);
    size.h -= accessorySize.h + self->stackView->spacing;
  }
 
  return size;
}

◆ initWithFrame()

Panel * initWithFrame	(	Panel *	self,
		const SDL_Rect *	frame
	)

Initializes this Panel with the specified frame and style.

Parameters

self	The Panel.
frame	The frame.

Returns: The initialized Panel, or NULL on error.

Definition at line 220 of file Panel.c.

                                                                {
 
  self = (Panel *) super(Control, self, initWithFrame, frame);
  if (self) {
    View *this = (View *) self;
 
    self->isDraggable = true;
    self->isResizable = true;
 
    self->stackView = $(alloc(StackView), initWithFrame, NULL);
    assert(self->stackView);
 
    $(this, addSubview, (View *) self->stackView);
 
    self->contentView = $(alloc(StackView), initWithFrame, NULL);
    assert(self->contentView);
 
    $((View *) self->contentView, addClassName, "contentView");
    $((View *) self->contentView, addClassName, "container");
 
    self->contentView->view.autoresizingMask |= ViewAutoresizingWidth;
 
    $((View *) self->stackView, addSubview, (View *) self->contentView);
 
    self->accessoryView = $(alloc(StackView), initWithFrame, NULL);
    assert(self->accessoryView);
 
    $((View *) self->accessoryView, addClassName, "accessoryView");
    $((View *) self->accessoryView, addClassName, "container");
 
 
    $((View *) self->stackView, addSubview, (View *) self->accessoryView);
 
    self->resizeHandle = $(alloc(ImageView), initWithImage, _resize);
    assert(self->resizeHandle);
 
    $((View *) self->resizeHandle, addClassName, "resizeHandle");
 
    self->resizeHandle->view.frame.w = DEFAULT_PANEL_RESIZE_HANDLE_SIZE;
    self->resizeHandle->view.frame.h = DEFAULT_PANEL_RESIZE_HANDLE_SIZE;
 
    $((View *) self, addSubview, (View *) self->resizeHandle);
  }
 
  return self;
}

Field Documentation

◆ accessoryView

StackView* Panel::accessoryView

The optional accessories container.

Remarks: This View is hidden by default.

Definition at line 64 of file Panel.h.

◆ contentView

StackView* Panel::contentView

The internal container.

Definition at line 69 of file Panel.h.

◆ control

Control Panel::control

The superclass.

Definition at line 52 of file Panel.h.

◆ interface

PanelInterface* Panel::interface[0]

protected

The interface type.

Definition at line 58 of file Panel.h.

◆ isDraggable

bool Panel::isDraggable

If true, this Panel may be repositioned by the user.

Remarks: Styled. Set from a Style, and overwritten by the next one applied. Assign View::style, or a stylesheet rule, rather than this field.

Definition at line 75 of file Panel.h.

◆ isDragging

bool Panel::isDragging

True if the user is repositioning this Panel.

Definition at line 80 of file Panel.h.

◆ isResizable

bool Panel::isResizable

If true, this Panel may be resized by the user.

Remarks: Styled. Set from a Style, and overwritten by the next one applied. Assign View::style, or a stylesheet rule, rather than this field.

Definition at line 86 of file Panel.h.

◆ isResizing

bool Panel::isResizing

True if the user is resizing this Panel.

Definition at line 91 of file Panel.h.

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

Sources/ObjectivelyMVC/Panel.h
Sources/ObjectivelyMVC/Panel.c

Public Member Functions

Data Fields

Protected Attributes