View Struct Reference

Views are the fundamental building blocks of ObjectivelyMVC user interfaces. More...

#include <View.h>

Inheritance diagram for View:

Public Member Functions
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
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
ViewInterface *	interface [0]
	The interface type.

Detailed Description

Views are the fundamental building blocks of ObjectivelyMVC user interfaces.

Views provide organization and coordination of layout, drawing and event handling. Views maintain hierarchical relationships among other Views, whereby each View's parent, or superview, dictates where it will be drawn on the screen, which events it will be eligible to receive, etc.

Definition at line 225 of file View.h.

Member Function Documentation

_View()

Class * _View

(

void

)

The View archetype.

Returns

The View Class.

Definition at line 2336 of file View.c.

                   {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "View",
      .superclass = _Object(),
      .instanceSize = sizeof(View),
      .interfaceSize = sizeof(ViewInterface),
      .initialize = initialize,
    });
  });
 
  return clazz;
}

acceptsKeyResponder()

bool acceptsKeyResponder

(

const View *

self

)

Parameters

self

The View.

Returns

True if this View can become the key responder, false otherwise.

Definition at line 69 of file Control.c.

                                                  {
 
  Control *this = (Control *) self;
 
  return (this->state & ControlStateDisabled) == 0;
}

acceptsTouchResponder()

bool acceptsTouchResponder

(

const View *

self

)

Parameters

self

The View.

Returns

True if this View can become the touch responder, false otherwise.

Definition at line 79 of file Control.c.

                                                    {
 
  Control *this = (Control *) self;
 
  return (this->state & ControlStateDisabled) == 0;
}

addClassName()

void addClassName	(	View *	self,
		const char *	className
	)

Adds the given class name to this View.

Parameters

self	The View.
className	The class name.

Definition at line 183 of file View.c.

                                                            {
 
  if (className) {
 
    String *string = $$(String, stringWithCharacters, className);
    assert(string);
 
    $(self->classNames, addObject, string);
    release(string);
 
    $(self, invalidateStyle);
  }
}

addSubview()

void addSubview	(	View *	self,
		View *	subview
	)

Adds a subview to this view, to be drawn above its siblings.

Parameters

self	The View.
subview	The subview to add.

Remarks

This method is equivalent to $(view, addSubviewRelativeTo, subview, NULL, OrderSame).

Definition at line 49 of file PageView.c.

                                                  {
 
  super(View, self, addSubview, subview);
 
  PageView *this = (PageView *) self;
 
  $(subview, setVisibility, ViewVisibilityHidden);
 
  if (this->currentPage == NULL) {
    $(this, setCurrentPage, subview);
  }
}

addSubviewRelativeTo()

void addSubviewRelativeTo	(	View *	self,
		View *	subview,
		View *	other,
		ViewPosition	position
	)

Adds a subview to this view, positioned relatively to other.

Parameters

self	The View.
subview	The subview to add.
other	An optional View to position subview relative to.
position	The relative position.

Definition at line 209 of file View.c.

                                                                                                {
 
  assert(subview);
  assert(subview != other);
 
  retain(subview);
 
  $(subview, removeFromSuperview);
 
  if (other && other->superview == self) {
 
    const Array *subviews = (Array *) self->subviews;
    const ssize_t index = $(subviews, indexOfObject, other);
 
    if (position == ViewPositionAfter) {
      if (index == (ssize_t) (subviews->count - 1)) {
        $(self->subviews, addObject, subview);
      } else {
        $(self->subviews, insertObjectAtIndex, subview, index + 1);
      }
    } else {
      $(self->subviews, insertObjectAtIndex, subview, index);
    }
  } else {
    $(self->subviews, addObject, subview);
  }
 
  release(subview);
 
  subview->superview = self;
 
  $(subview, moveToWindow, self->window);
 
  $(subview, invalidateStyle);
 
  $(self, setNeedsLayout);
}

ancestorWithIdentifier()

ancestorWithIdentifier	(	const View *	self,
		const char *	identifier
	)

Parameters

self	The View.
identifier	The identifier.

Returns

The nearest ancestor View matching the given identifier.

Definition at line 251 of file View.c.

                                                                              {
 
  assert(identifier);
 
  View *view = (View *) self;
  while (view) {
    if (view->identifier) {
      if (strcmp(identifier, view->identifier) == 0) {
        return view;
      }
    }
    view = view->superview;
  }
 
  return NULL;
}

applyStyle()

void applyStyle	(	View *	self,
		const Style *	style
	)

Applies the given Style to this View.

Parameters

self	The View.
style	The Style.

Definition at line 59 of file CollectionView.c.

                                                       {
 
  super(View, self, applyStyle, style);
 
  CollectionView *this = (CollectionView *) self;
 
  const Inlet inlets[] = MakeInlets(
    MakeInlet("axis", InletTypeEnum, &this->axis, (ident) CollectionViewAxisNames),
    MakeInlet("item-size", InletTypeSize, &this->itemSize, NULL),
    MakeInlet("item-spacing", InletTypeSize, &this->itemSpacing, NULL)
  );
 
  $(self, bind, inlets, (Dictionary *) style->attributes);
}

applyTheme()

void applyTheme	(	View *	self,
		const Theme *	theme
	)

Applies the given Theme to this View.

Parameters

self	The View.
theme	The Theme.

Definition at line 335 of file View.c.

                                                       {
 
  assert(theme);
 
  Style *computedStyle = $(theme, computeStyle, self);
  assert(computedStyle);
 
  if (self->needsApplyStyle || !$(self->computedStyle, isComputedEqual, computedStyle)) {
 
    release(self->computedStyle);
    self->computedStyle = retain(computedStyle);
 
    $(self->computedStyle, addAttributes, self->style->attributes);
    $(self, applyStyle, self->computedStyle);
 
    self->needsApplyStyle = false;
  }
 
  release(computedStyle);
}

applyThemeIfNeeded()

void applyThemeIfNeeded	(	View *	self,
		const Theme *	theme
	)

Recursively applies the Theme to this View and its subviews.

Parameters

self	The View.
theme	The Theme.

Definition at line 369 of file View.c.

                                                               {
 
  assert(theme);
 
  if (!self->needsApplyTheme && !self->needsApplyThemeSubviews) {
    return;
  }
 
  // Cleared before descending so that any re-invalidation during the traversal
  // propagates fresh subtree flags and survives to the next frame.
  self->needsApplyThemeSubviews = false;
 
  $(self, enumerateSubviews, _applyThemeIfNeeded, (ident) theme);
 
  if (self->needsApplyTheme) {
 
    $(self, clearWarnings, WarningTypeStyle);
 
    $(self, applyTheme, theme);
 
    self->needsApplyTheme = false;
  }
}

attachStylesheet()

void attachStylesheet	(	View *	self,
		SDL_Window *	window
	)

Attaches this View's Stylesheet to the Theme associated with the given window.

Parameters

self	The View.
window	The window.

Definition at line 397 of file View.c.

                                                             {
 
  assert(window);
 
  if (self->stylesheet) {
    Theme *theme = $$(Theme, theme, window);
    if (theme) {
      $(theme, addStylesheet, self->stylesheet);
    }
  }
}

awakeWithCharacters()

void awakeWithCharacters	(	View *	self,
		const char *	chars
	)

Wakes this View with the given null-terminated JSON C string.

Parameters

self	The View.
chars	A null-terminated JSON C string describing this View.

Remarks

This is a convenience method for View::awakeWithDictionary.

Definition at line 413 of file View.c.

                                                               {
 
  Data *data = $$(Data, dataWithConstMemory, (uint8_t *) chars, strlen(chars));
 
  $(self, awakeWithData, data);
 
  release(data);
}

awakeWithData()

void awakeWithData	(	View *	self,
		const Data *	data
	)

Wakes this View with the specified JSON Data.

Parameters

self	The View.
data	The JSON Data containing properties describing this View.

Remarks

This is a convenience method for View::awakeWithDictionary.

Definition at line 426 of file View.c.

                                                        {
 
  JSONContext *ctx = $(alloc(JSONContext), init);
  Dictionary *dictionary = $(ctx, objectFromData, data, 0);
 
  if (dictionary) {
    $(self, awakeWithDictionary, dictionary);
    release(dictionary);
  } else {
    MVC_LogError("Failed to parse JSON for %s\n", classnameof(self));
  }
 
  release(ctx);
}

awakeWithDictionary()

void awakeWithDictionary	(	View *	self,
		const Dictionary *	dictionary
	)

Wakes this View with the specified Dictionary.

Parameters

self	The View.
dictionary	A Dictionary of properties describing this View.

Remarks

This method is invoked when loading via JSON. Subclasses should override this method to perform any customization based on the contents of dictionary.

Definition at line 50 of file Box.c.

                                                                          {
 
  super(View, self, awakeWithDictionary, dictionary);
 
  Box *this = (Box *) self;
 
  const Inlet inlets[] = MakeInlets(
    MakeInlet("contentView", InletTypeView, &this->contentView, NULL),
    MakeInlet("label", InletTypeView, &this->label, NULL)
  );
 
  $(self, bind, inlets, dictionary);
}

awakeWithResource()

void awakeWithResource	(	View *	self,
		const Resource *	resource
	)

Wakes this View with the specified Resource.

Parameters

self	The View.
resource	A Resource providing JSON data describing this View.

Definition at line 463 of file View.c.

                                                                    {
 
  assert(resource);
 
  $(self, awakeWithData, resource->data);
}

awakeWithResourceName()

void awakeWithResourceName	(	View *	self,
		const char *	name
	)

Wakes this View with the Resource by the specified name.

Parameters

self	The View.
name	The name of a Resource providing JSON data describing this View.

Definition at line 474 of file View.c.

                                                                {
 
  Resource *resource = $$(Resource, resourceWithName, name);
 
  $(self, awakeWithResource, resource);
 
  release(resource);
}

becomeKeyResponder()

void becomeKeyResponder

(

View *

self

)

Become the key responder in the View hierarchy.

Parameters

self

The View.

Remarks

Becoming the key responder gives a View priority when handling key events.

Definition at line 132 of file Control.c.

                                           {
 
  Control *this = (Control *) self;
 
  if (!$(this, isFocused)) {
 
    this->state |= ControlStateFocused;
 
    $(this, stateDidChange);
  }
 
  super(View, self, becomeKeyResponder);
}

becomeTouchResponder()

void becomeTouchResponder

(

View *

self

)

Become the touch responder in the View hierarchy.

Parameters

self

The View.

Remarks

Becoming the touch responder gives a View priority when handling touch events.

Definition at line 511 of file View.c.

                                             {
 
  assert(self->window);
 
  if (!$(self, isTouchResponder)) {
    SDL_PropertiesID props = SDL_GetWindowProperties(self->window);
 
    View *touchResponder = SDL_GetPointerProperty(props, "touchResponder", NULL);
    if (touchResponder) {
      $(touchResponder, resignTouchResponder);
    }
 
    String *path = $(self, path);
    MVC_LogDebug("%s\n", path->chars);
    release(path);
 
    SDL_SetPointerProperty(props, "touchResponder", self);
  }
}

bind()

bool bind	(	View *	self,
		const Inlet *	inlets,
		const Dictionary *	dictionary
	)

Performs data binding for the Inlets described in dictionary.

Parameters

self	The View.
inlets	The Inlets to bind.
dictionary	A Dictionary describing this View.

Returns

True if one or more Inlet was bound, false otherwise.

Remarks

Subclasses will typically call this method from View::awakeWithDictionary.

bounds()

SDL_Rect bounds

(

const View *

self

)

Parameters

self

The View.

Returns

The bounds (frame minus padding) of this View.

Definition at line 552 of file View.c.

                                         {
 
  const SDL_Size size = $(self, size);
 
  const SDL_Rect bounds = {
    .x = self->padding.left,
    .y = self->padding.top,
    .w = max(0, size.w - (self->padding.left + self->padding.right)),
    .h = max(0, size.h - (self->padding.top + self->padding.bottom)),
  };
 
  return bounds;
}

bringSubviewToFront()

void bringSubviewToFront	(	View *	self,
		View *	subview
	)

Brings the specified subview to the front.

Parameters

self	The View.
subview	The subview.

Definition at line 570 of file View.c.

                                                           {
 
  assert(subview);
 
  if (subview->superview == self) {
 
    View *last = $((Array *) self->subviews, lastObject);
    if (last != subview) {
      $(self, addSubviewRelativeTo, subview, last, ViewPositionAfter);
    }
  }
}

clearWarnings()

void clearWarnings	(	const View *	self,
		WarningType	level
	)

Clears this View's Warnings matching the given level.

Parameters

self	The View.
type	The bitmask of WarningTypes to clear.

Definition at line 598 of file View.c.

                                                              {
  $(self->warnings, filter, clearWarnings_predicate, &type);
}

clippingFrame()

SDL_Rect clippingFrame

(

const View *

self

)

Parameters

self

The View.

Returns

The visible portion of this View's frame, in window coordinates.

Remarks

This is equivalent to the View's renderFrame, expanded for border width, and clipped to all ancestors.

Definition at line 606 of file View.c.

                                                {
 
  View *this = (View *) self;
 
  if (_renderFrameGeneration && this->clippingFrameCache.generation == _renderFrameGeneration) {
    return this->clippingFrameCache.frame;
  }
 
  SDL_Rect frame = $(self, renderFrame);
 
  if (self->borderWidth && self->borderColor.a) {
    frame.x -= self->borderWidth;
    frame.y -= self->borderWidth;
    frame.w += self->borderWidth * 2;
    frame.h += self->borderWidth * 2;
  }
 
  // The nearest clipping ancestor's clippingFrame already folds in every outer clip, so a
  // single intersection with it is equivalent to intersecting each clipping ancestor in turn.
  const View *superview = self->superview;
  while (superview && !superview->clipsSubviews) {
    superview = superview->superview;
  }
 
  if (superview) {
    const SDL_Rect clippingFrame = $(superview, clippingFrame);
    if (SDL_GetRectIntersection(&clippingFrame, &frame, &frame) == false) {
      frame.w = frame.h = 0;
    }
  }
 
  this->clippingFrameCache.frame = frame;
  this->clippingFrameCache.generation = _renderFrameGeneration;
 
  return frame;
}

containsPoint()

bool containsPoint	(	const View *	self,
		const SDL_Point *	point
	)

Parameters

self	The View.
point	A point in object space.

Returns

True if the point falls within this View's clipped frame.

Definition at line 647 of file View.c.

                                                                    {
 
  const SDL_Rect frame = $(self, clippingFrame);
 
  return (bool) SDL_PointInRect(point, &frame);
}

depth()

int depth

(

const View *

self

)

Parameters

self

The View.

Returns

The depth of this View (ancestor depth + 1).

Definition at line 658 of file View.c.

                                   {
  return (self->superview ? $(self->superview, depth) + 1 : 0);
}

descendantWithIdentifier()

descendantWithIdentifier	(	const View *	self,
		const char *	identifier
	)

Parameters

self	The View.
identifier	The identifier.

Returns

The nearest descendant View matching the given identifier.

Definition at line 666 of file View.c.

                                                                                {
 
  assert(identifier);
 
  if (self->identifier) {
    if (strcmp(identifier, self->identifier) == 0) {
      return (View *) self;
    }
  }
 
  const Array *subviews = (Array *) self->subviews;
  for (size_t i = 0; i < subviews->count; i++) {
 
    const View *subview = subviews->elements[i];
    View *descendant = $(subview, descendantWithIdentifier, identifier);
    if (descendant) {
      return descendant;
    }
  }
 
  return NULL;
}

detachStylesheet()

void detachStylesheet	(	View *	self,
		SDL_Window *	window
	)

Detaches this View's Stylesheet from the Theme associated with the given window.

Parameters

self	The View.
window	The window.

Definition at line 693 of file View.c.

                                                             {
 
  assert(window);
 
  if (self->stylesheet) {
    Theme *theme = $$(Theme, theme, window);
    if (theme) {
      $(theme, removeStylesheet, self->stylesheet);
    }
  }
}

didMoveToWindow()

void didMoveToWindow	(	View *	self,
		SDL_Window *	window
	)

Informs this View that it has been added to the View hierachy of the given window.

Parameters

self	The View.
window	The window, or NULL if this View has been removed from the window.

Definition at line 90 of file ImageView.c.

                                                            {
 
  super(View, self, didMoveToWindow, window);
 
  ImageView *this = (ImageView *) self;
 
  // leaving a window resolves nothing: there is no density to resolve against, and View::dealloc
  // moves to a NULL window, where loading an image would be worse than pointless
  if (window == NULL) {
    return;
  }
 
  if (this->imageName == NULL) {
    return;
  }
 
  char *name = this->imageName;
  this->imageName = NULL;
 
  Theme *theme = $$(Theme, theme, window);
  if (theme) {
    Image *image = $(theme, image, name, SDL_GetWindowPixelDensity(window));
    $(this, setImage, image);
  } else {
    Image *image = $$(Image, imageWithResourceName, name, SDL_GetWindowPixelDensity(window));
    $(this, setImage, image);
    release(image);
  }
 
  this->imageName = name;
}

didReceiveEvent()

bool didReceiveEvent	(	const View *	self,
		const SDL_Event *	event
	)

Parameters

self	The View.
event	The event.

Returns

True if this View received the event, false otherwise.

Definition at line 726 of file View.c.

                                                                      {
 
  if ($(self, isKeyResponder)) {
    switch (event->type) {
      case SDL_EVENT_KEY_DOWN:
      case SDL_EVENT_KEY_UP:
      case SDL_EVENT_TEXT_INPUT:
        return true;
    }
  }
 
  if ($(self, isVisible)) {
 
    SDL_Point point;
 
    switch (event->type) {
      case SDL_EVENT_MOUSE_BUTTON_DOWN:
      case SDL_EVENT_MOUSE_BUTTON_UP:
        point = MakePoint(event->button.x, event->button.y);
        break;
      case SDL_EVENT_MOUSE_MOTION:
        point = MakePoint(event->motion.x, event->motion.y);
        break;
      case SDL_EVENT_MOUSE_WHEEL: {
        float mx, my;
        SDL_GetMouseState(&mx, &my);
        point = MakePoint(mx, my);
        break;
      }
      default:
        return false;
    }
 
    return $(self, containsPoint, &point);
  }
 
  return false;
}

draw()

void draw	(	View *	self,
		Renderer *	renderer
	)

Draws this View.

Parameters

self	The View.
renderer	The Renderer.

Remarks

This method determines if the View is visible and dispatches Renderer::drawView before recursing down the View hierarchy. Rasterization is performed in View::render.

See also

View::render(View *, Renderer *)

Definition at line 778 of file View.c.

                                                 {
 
  assert(self->window);
 
  if (self->visibility != ViewVisibilityHidden) {
 
    $(renderer, drawView, self);
 
    $(self, enumerateSubviews, _draw, renderer);
  }
}

emitViewEvent()

void emitViewEvent	(	View *	self,
		ViewEvent	code,
		ident	data
	)

Emits a ViewEvent originating from this View.

Parameters

self	The View.
code	The ViewEvent code.
data	The ViewEvent data.

Remarks

This method is used for emitting events from Views (as opposed to responding to user or system generated events). These events are propagated up the View hierarchy.

Definition at line 794 of file View.c.

                                                                  {
  SDL_PushEvent((SDL_Event *) &(const SDL_UserEvent) {
    .type = MVC_VIEW_EVENT,
    .code = code,
    .data1 = self,
    .data2 = data
  });
}

enumerate() [1/2]

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

enumerate() [2/2]

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

Enumerates this View and its descendants, applying enumerator to each.

Parameters

self	The View.
enumerator	The ViewEnumerator.
data	User data.

Definition at line 807 of file View.c.

                                                                         {
 
  assert(enumerator);
 
  enumerator(self, data);
 
  $(self, enumerateDescendants, enumerator, data);
}

enumerateAdjacent()

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

Enumerates adjacent siblings of this View, applying enumerator to each.

Parameters

self	The View.
enumerator	The ViewEnumerator.
data	User data.

Definition at line 820 of file View.c.

                                                                                       {
 
  assert(enumerator);
 
  if (self->superview) {
    const Array *siblings = (Array *) self->superview->subviews;
    const ssize_t index = $(siblings, indexOfObject, (const ident) self);
    if (index > 0) {
      enumerator($(siblings, objectAtIndex, index - 1), data);
    }
    if (index < (ssize_t) (siblings->count - 1)) {
      enumerator($(siblings, objectAtIndex, index + 1), data);
    }
  }
}

enumerateAncestors()

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

Enumerates all ancestors of this View, applying enumerator to each.

Parameters

self	The View.
enumerator	The ViewEnumerator.
data	User data.

Definition at line 840 of file View.c.

                                                                                        {
 
  assert(enumerator);
 
  for (View *view = self->superview; view; view = view->superview) {
    enumerator(view, data);
  }
}

enumerateDescendants()

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

Enumerates all descendants of this View, applying enumerator to each.

Parameters

self	The View.
enumerator	The ViewEnumerator.
data	User data.

Definition at line 866 of file View.c.

                                                                                          {
 
  assert(enumerator);
 
  const Array *subviews = (Array *) self->subviews;
  for (size_t i = 0; i < subviews->count; i++) {
 
    View *subview = subviews->elements[i];
    enumerator(subview, data);
 
    $(subview, enumerateDescendants, enumerator, data);
  }
}

enumerateSelection()

void enumerateSelection	(	View *	self,
		const char *	rule,
		ViewEnumerator	enumerator,
		ident	data
	)

Enumerates all Views in the selection matched by rule, applying enumerator to each.

Parameters

self	The View.
rule	The Selector rule.
enumerator	The ViewEnumerator.
data	User data.

Definition at line 853 of file View.c.

                                                                                                    {
 
  Selector *selector = $(alloc(Selector), initWithRule, rule);
  assert(selector);
 
  $(selector, enumerateSelection, self, enumerator, data);
  release(selector);
}

enumerateSiblings()

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

Enumerates all siblings of this View, applying enumerator to each.

Parameters

self	The View.
enumerator	The ViewEnumerator.
data	User data.

Definition at line 884 of file View.c.

                                                                                       {
 
  assert(enumerator);
 
  if (self->superview) {
 
    const Array *siblings = (Array *) self->superview->subviews;
    for (size_t i = 0; i < siblings->count; i++) {
      View *sibling = siblings->elements[i];
      if (sibling != self) {
        enumerator(sibling, data);
      }
    }
  }
}

enumerateSubviews()

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

Enumerates all subviews of this View, applying enumerator to each.

Parameters

self	The View.
enumerator	The ViewEnumerator.
data	User data.

Definition at line 904 of file View.c.

                                                                                       {
 
  assert(enumerator);
 
  const Array *subviews = (Array *) self->subviews;
  for (size_t i = 0; i < subviews->count; i++) {
    enumerator((View *) subviews->elements[i], data);
  }
}

enumerateSuperview()

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

Enumerates the superview of this View, if any, applying enumerator to it.

Parameters

self	The View.
enumerator	The ViewEnumerator.
data	User data.

Definition at line 918 of file View.c.

                                                                                        {
 
  assert(enumerator);
 
  if (self->superview) {
    enumerator(self->superview, data);
  }
}

enumerateVisible() [1/2]

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

enumerateVisible() [2/2]

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

Enumerates this View and its visible descendants, applying enumerator to each.

This is an optimized path for enumerating only visible subtrees.

Parameters

self	The View.
enumerator	The ViewEnumerator.
data	User data.

Definition at line 931 of file View.c.

                                                                                {
 
  if ($(self, isVisible) == false) {
    return;
  }
 
  enumerator(self, data);
 
  const Array *subviews = (Array *) self->subviews;
  for (size_t i = 0; i < subviews->count; i++) {
 
    View *subview = subviews->elements[i];
    $(subview, enumerateVisible, enumerator, data);
  }
}

hasClassName()

bool hasClassName	(	const View *	self,
		cosnt char *	className
	)

Parameters

self	The View
className	The class name.

Returns

True if this View has the given class name, false otherwise.

hasOverflow()

bool hasOverflow

(

const View *

self

)

Parameters

self

The View

Returns

True if this View's visible subviews exceed this View's bounds.

Definition at line 997 of file View.c.

                                          {
 
  Overflow overflow = {
    .bounds = $(self, bounds)
  };
 
  $(self, enumerateSubviews, hasOverflow_enumerate, (ident) &overflow);
 
  return overflow.hasOverflow;
}

hitTest()

View * hitTest	(	const View *	self,
		const SDL_Point *	point
	)

Performs a hit test against this View and its descendants for the given point.

Parameters

self	The View.
point	The point to test.

Returns

The furthest descendant View that contains the given point, or NULL.

Remarks

Hidden Views and Views with pointerEvents disabled are never returned, though the subviews of the latter are still tested.

Definition at line 1012 of file View.c.

                                                               {
 
  if (self->visibility != ViewVisibilityHidden) {
 
    if ($(self, containsPoint, point)) {
 
      const Array *subviews = (Array *) self->subviews;
      for (size_t i = subviews->count; i; i--) {
 
        const View *subview = subviews->elements[i - 1];
        const View *view = $(subview, hitTest, point);
        if (view) {
          return (View *) view;
        }
      }
 
      return self->pointerEvents == ViewPointerEventsAuto ? (View *) self : NULL;
    }
  }
 
  return NULL;
}

init()

View * init

(

View *

self

)

Initializes this View.

Parameters

self

The View.

Returns

The initialized View, or NULL on error.

Remarks

View::viewWithDictionary invokes this initializer when loading Views. Subclasses wishing to support JSON binding must override this method to call their designated initializer.

Definition at line 67 of file Box.c.

                              {
  return (View *) $((Box *) self, initWithFrame, NULL);
}

initWithFrame()

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

Initializes this View with the specified frame.

Parameters

self	The View.
frame	The frame.

Returns

The initialized View, or NULL on error.

Remarks

Designated initializer.

Definition at line 1047 of file View.c.

                                                              {
 
  self = (View *) super(Object, self, init);
  if (self) {
 
    if (frame) {
      self->frame = *frame;
    }
 
    self->classNames = $$(Set, setWithCapacity, 0);
    assert(self->classNames);
 
    self->computedStyle = $(alloc(Style), initWithAttributes, NULL);
    assert(self->computedStyle);
 
    self->subviews = $$(Array, arrayWithCapacity, 0);
    assert(self->subviews);
 
    self->style = $(alloc(Style), initWithAttributes, NULL);
    assert(self->style);
 
    self->warnings = $$(Array, arrayWithCapacity, 0);
    assert(self->warnings);
 
    self->needsApplyTheme = true;
    self->needsLayout = true;
  }
 
  return self;
}

invalidateStyle()

void invalidateStyle

(

View *

self

)

Invalidates the computed Style for this View and its descendants.

Parameters

self

The View.

Definition at line 1092 of file View.c.

                                        {
  $(self, enumerate, invalidateStyle_enumerate, NULL);
}

isContainer()

bool isContainer

(

const View *

self

)

Parameters

self

The view.

Returns

True if this View's autoresizing mask includes Fit or Contain.

Definition at line 1100 of file View.c.

                                          {
  return self->autoresizingMask & (ViewAutoresizingFit | ViewAutoresizingContain);
}

isDescendantOfView()

bool isDescendantOfView	(	const View *	self,
		const View *	view
	)

Parameters

self	The View.
view	The View to test against this View's hierarchy.

Returns

True if this View is a descendant of, or equal to, the given View.

Definition at line 1108 of file View.c.

                                                                   {
 
  assert(view);
 
  while (self) {
    if (self == view) {
      return true;
    }
    self = self->superview;
  }
 
  return false;
}

isKeyResponder()

bool isKeyResponder

(

const View *

self

)

Parameters

self

The View.

Returns

True if this View is the first responder, false otherwise.

Definition at line 1126 of file View.c.

                                             {
 
  if (self->window) {
    return SDL_GetPointerProperty(SDL_GetWindowProperties(self->window), "keyResponder", NULL) == self;
  } else {
    return false;
  }
}

isTouchResponder()

bool isTouchResponder

(

const View *

self

)

Parameters

self

The View.

Returns

True if this View is responding to mouse and touch events, false otherwise.

Definition at line 1139 of file View.c.

                                               {
 
  if (self->window) {
    return SDL_GetPointerProperty(SDL_GetWindowProperties(self->window), "touchResponder", NULL) == self;
  } else {
    return false;
  }
}

isVisible()

bool isVisible

(

const View *

self

)

Parameters

self

The View.

Returns

True if this View is visible, false if it, or an ancestor, is hidden.

Definition at line 1152 of file View.c.

                                        {
 
  for (const View *view = self; view; view = view->superview) {
    if (view->visibility == ViewVisibilityHidden) {
      return false;
    }
  }
 
  return true;
}

layoutIfNeeded()

void layoutIfNeeded

(

View *

self

)

Recursively updates the layout of this View and its subviews.

Parameters

self

The View.

Remarks

Drives the two-phase layout pass for a dirty View: View::sizeThatSatisfies resolves this View's own size (bottom-up, from its subviews), if it is a container, before View::layoutSubviews arranges its subviews (top-down) using that now-final frame. This ordering guarantees every View's size is settled before any View's position is committed.

Definition at line 1174 of file View.c.

                                       {
 
  if (!self->needsLayout && !self->needsLayoutSubviews) {
    return;
  }
 
  // Cleared before laying out so that any re-invalidation during layout (e.g. a resize
  // propagating setNeedsLayout, or a widget marking a sibling) survives to the next frame.
  self->needsLayoutSubviews = false;
 
  // Subviews first, so that a dirty descendant whose layout resizes it marks its ancestors
  // before their own dirty checks below run; the whole tree then converges bottom-up in a
  // single pass, exactly as invalidations propagate.
  $(self, enumerateSubviews, layoutIfNeeded_enumerate, NULL);
 
  if (self->needsLayout) {
 
    // No ancestor is actively arranging self right now, so there's no fresh constraint to
    // consult; treat an existing frame as authoritative per-axis (Equal, not Max -- see
    // ViewConstraintMax), leaving an axis with no frame yet Unspecified.
    const ViewConstraint w = self->frame.w ?
      MakeConstraint(ViewConstraintEqual, self->frame.w) : MakeConstraint(ViewConstraintUnspecified, 0);
    const ViewConstraint h = self->frame.h ?
      MakeConstraint(ViewConstraintEqual, self->frame.h) : MakeConstraint(ViewConstraintUnspecified, 0);
 
    $(self, layoutWithConstraint, w, h);
  }
}

layoutSubviews()

layoutSubviews

(

View *

self

)

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

Parameters

self

The View.

Remarks

Subclasses may override this method to perform their own arrangement of subviews. This method is called by View::layoutIfNeeded only after a View::sizeThatSatisfies pass has already resolved self->frame; it must not perform any sizing of its own, only positioning and committing of subview frames.

Definition at line 74 of file Box.c.

                                       {
 
  super(View, self, layoutSubviews);
 
  View *label = (View *) ((Box *) self)->label;
  if (label->visibility != ViewVisibilityHidden) {
 
    const SDL_Size size = $(label, sizeThatContains);
    label->frame.y = -size.h * 0.5;
  }
}

layoutWithConstraint()

void layoutWithConstraint	(	View *	self,
		ViewConstraint	width,
		ViewConstraint	height
	)

Resolves this View's size against the given ViewConstraints, then arranges it.

Parameters

self	The View.
width	The ViewConstraint offered for this View's width.
height	The ViewConstraint offered for this View's height.

Remarks

This is the shared tail of View::layoutIfNeeded: resolve self's size via View::sizeToSatisfy, then View::layoutSubviews, then clear needsLayout.

See also

View::layoutWithSize(View *, const SDL_Size *)

Definition at line 1254 of file View.c.

                                                                                          {
 
  $(self, sizeToSatisfy, width, height);
  $(self, clearWarnings, WarningTypeLayout);
  $(self, layoutSubviews);
 
  self->needsLayout = false;
}

layoutWithSize()

void layoutWithSize	(	View *	self,
		const SDL_Size *	size
	)

Resizes this View to the given size, then arranges it.

Parameters

self	The View.
size	The size to resize this View to.

Remarks

Like View::layoutWithConstraint, but for a caller that has already computed this View's exact final size and must apply it verbatim – e.g. a StackView applying its distribution math to a subview.

See also

View::layoutWithConstraint(View *, ViewConstraint, ViewConstraint)

Definition at line 1267 of file View.c.

                                                             {
 
  $(self, resize, size);
  $(self, clearWarnings, WarningTypeLayout);
  $(self, layoutSubviews);
 
  self->needsLayout = false;
}

matchesSelector()

bool matchesSelector	(	const View *	self,
		const SimpleSelector *	simpleSelector
	)

Parameters

self	The View.
simpleSelector	The SimpleSelector.

Returns

True if this View matches the SimpleSelector, false otherwise.

Definition at line 51 of file CollectionItemView.c.

                                                                                    {
 
  assert(simpleSelector);
 
  const CollectionItemView *this = (CollectionItemView *) self;
  const char *pattern = simpleSelector->pattern;
 
  switch (simpleSelector->type) {
    case SimpleSelectorTypePseudo:
      if (strcmp("selected", pattern) == 0) {
        return this->isSelected;
      }
      break;
    default:
      break;
  }
 
  return super(View, self, matchesSelector, simpleSelector);
}

moveToWindow()

void moveToWindow	(	View *	self,
		SDL_Window *	window
	)

Moves this View to the View hierarchy of the given window.

Parameters

self	The View.
window	The window, or NULL if this View is moving from its current window.

Definition at line 1351 of file View.c.

                                                         {
 
  $(self, willMoveToWindow, window);
 
  if (self->window && self->window != window) {
    SDL_PropertiesID props = SDL_GetWindowProperties(self->window);
 
    if (SDL_GetPointerProperty(props, "keyResponder", NULL) == self) {
      SDL_SetPointerProperty(props, "keyResponder", NULL);
    }
 
    if (SDL_GetPointerProperty(props, "touchResponder", NULL) == self) {
      SDL_SetPointerProperty(props, "touchResponder", NULL);
    }
  }
 
  self->window = window;
 
  $(self, didMoveToWindow, window);
 
  $(self, enumerateSubviews, moveToWindow_enumerate, window);
}

path()

String * path

(

const View *

self

)

Parameters

self

The View.

Returns

A unique CSS selector matching this View.

Definition at line 1378 of file View.c.

                                      {
 
  Array *parts = $$(Array, array);
 
  const View *view = self;
  while (view) {
 
    Array *classNames = $((Set *) view->classNames, allObjects);
 
    String *part;
    if (view->identifier) {
      part = str("#%s", view->identifier);
    } else if (classNames->count) {
      part = str(".%s", ((String *) $(classNames, firstObject))->chars);
    } else {
      part = str("%s", classnameof(view));
    }
 
    release(classNames);
 
    $(parts, insertObjectAtIndex, part, 0);
    release(part);
 
    if (view->viewController) {
      break;
    }
 
    view = view->superview;
  }
 
  String *path = $((Array *) parts, componentsJoinedByCharacters, " > ");
 
  release(parts);
 
  return path;
}

removeAllClassNames()

void removeAllClassNames

(

View *

self

)

Removes all class names from this View.

Parameters

self

The View.

Definition at line 1419 of file View.c.

                                            {
 
  $(self->classNames, removeAllObjects);
 
  $(self, invalidateStyle);
}

removeAllSubviews()

void removeAllSubviews

(

View *

self

)

Removes all subviews from this View.

Parameters

self

The View.

Definition at line 1437 of file View.c.

                                          {
  $(self->subviews, removeAllObjectsWithEnumerator, removeAllSubviews_enumerate, self);
}

removeClassName()

void removeClassName	(	View *	self,
		const char *	className
	)

Removes the given class name to this View.

Parameters

self	The View.
className	The class name.

Definition at line 1445 of file View.c.

                                                               {
 
  if (className) {
    String *string = $$(String, stringWithCharacters, className);
    assert(string);
 
    $(self->classNames, removeObject, string);
    release(string);
 
    $(self, invalidateStyle);
  }
}

removeFromSuperview()

void removeFromSuperview

(

View *

self

)

Removes this View from its superview.

Parameters

self

The View.

Definition at line 1462 of file View.c.

                                            {
 
  if (self->superview) {
    $(self->superview, removeSubview, self);
  }
}

removeSubview()

void removeSubview	(	View *	self,
		View *	subview
	)

Removes the given subview from this View.

Parameters

self	The View.
subview	The subview.

Definition at line 72 of file PageView.c.

                                                     {
 
  PageView *this = (PageView *) self;
 
  retain(subview);
 
  super(View, self, removeSubview, subview);
 
  $(subview, setVisibility, ViewVisibilityVisible);
 
  if (subview == this->currentPage) {
    $(this, setCurrentPage, NULL);
  }
 
  release(subview);
}

render()

void render	(	View *	self,
		Renderer *	renderer
	)

Renders this View using the given renderer.

Parameters

self	The View.
renderer	The Renderer.

Remarks

Subclasses should override this method to perform actual drawing operations. This method is called by draw as the View hierarchy is drawn.

Definition at line 181 of file Control.c.

                                                   {
 
  super(View, self, render, renderer);
 
  Control *this = (Control *) self;
 
  const SDL_Rect frame = $(self, renderFrame);
 
  if (self->borderRadius > 0) {
 
    if (this->bevel == ControlBevelInset) {
      $(renderer, drawBevel, &frame, self->borderRadius, 1, &this->bevelDarkColor, &this->bevelLightColor);
    } else if (this->bevel == ControlBevelOutset) {
      $(renderer, drawBevel, &frame, self->borderRadius, 1, &this->bevelLightColor, &this->bevelDarkColor);
    }
 
    if (this->state & ControlStateFocused) {
      $(renderer, drawRoundedRect, &frame, self->borderRadius, 1, &Colors.Charcoal);
    }
 
  } else {
 
    if (this->bevel == ControlBevelInset) {
 
      SDL_Point points[3];
 
      points[0].x = frame.x;
      points[0].y = frame.y + frame.h;
 
      points[1].x = frame.x + frame.w;
      points[1].y = frame.y + frame.h;
 
      points[2].x = frame.x + frame.w;
      points[2].y = frame.y;
 
      $(renderer, drawLines, points, lengthof(points), &this->bevelLightColor);
 
      points[0].x = frame.x;
      points[0].y = frame.y + frame.h;
 
      points[1].x = frame.x;
      points[1].y = frame.y;
 
      points[2].x = frame.x + frame.w;
      points[2].y = frame.y;
 
      $(renderer, drawLines, points, lengthof(points), &this->bevelDarkColor);
 
    } else if (this->bevel == ControlBevelOutset) {
 
      SDL_Point points[3];
 
      points[0].x = frame.x;
      points[0].y = frame.y + frame.h;
 
      points[1].x = frame.x + frame.w;
      points[1].y = frame.y + frame.h;
 
      points[2].x = frame.x + frame.w;
      points[2].y = frame.y;
 
      $(renderer, drawLines, points, lengthof(points), &this->bevelDarkColor);
 
      points[0].x = frame.x;
      points[0].y = frame.y + frame.h;
 
      points[1].x = frame.x;
      points[1].y = frame.y;
 
      points[2].x = frame.x + frame.w;
      points[2].y = frame.y;
 
      $(renderer, drawLines, points, lengthof(points), &this->bevelLightColor);
    }
 
    if (this->state & ControlStateFocused) {
      $(renderer, drawRect, &frame, &Colors.Charcoal);
    }
  }
}

renderDeviceDidReset()

void renderDeviceDidReset

(

View *

self

)

Informs this View that the render device has reset.

Parameters

self

The View.

Remarks

Subclasses may override this method to allocate any OpenGL objects they require.

Definition at line 776 of file Text.c.

                                             {
 
  refreshFont((Text *) self);
 
  $(self, sizeToFit);
 
  super(View, self, renderDeviceDidReset);
}

renderDeviceWillReset()

void renderDeviceWillReset

(

View *

self

)

Informs this View that the render device will reset.

Parameters

self

The View.

Remarks

Subclasses should override this method to free any OpenGL objects they own.

Definition at line 184 of file ImageView.c.

                                              {
 
  ImageView *this = (ImageView *) self;
 
  this->texture = release(this->texture);
 
  if (this->image && $((Object *) this->image, isKindOfClass, _AtlasImage())) {
    ImageAtlas *atlas = ((AtlasImage *) this->image)->atlas;
    if (atlas) {
      $(atlas, renderDeviceWillReset);
    }
  }
 
  super(View, self, renderDeviceWillReset);
}

renderFrame()

SDL_Frame renderFrame

(

const View *

self

)

Parameters

self

The View.

Returns

This View's absolute frame in the View hierarchy, in object space.

Definition at line 1629 of file View.c.

                                              {
 
  View *this = (View *) self;
 
  if (_renderFrameGeneration && this->renderFrameCache.generation == _renderFrameGeneration) {
    return this->renderFrameCache.frame;
  }
 
  SDL_Rect frame = self->frame;
 
  const View *superview = self->superview;
  if (superview) {
 
    const SDL_Rect superFrame = $(superview, renderFrame);
 
    frame.x += superFrame.x;
    frame.y += superFrame.y;
 
    if (self->alignment != ViewAlignmentInternal) {
      frame.x += superview->padding.left;
      frame.y += superview->padding.top;
    }
  }
 
  this->renderFrameCache.frame = frame;
  this->renderFrameCache.generation = _renderFrameGeneration;
 
  return frame;
}

replaceSubview()

void replaceSubview	(	View *	self,
		View *	subview,
		View *	replacement
	)

Replaces the specified subview with the given replacement.

Parameters

self	The View.
subview	The subview to replace.
replacement	The replacement subview.

Definition at line 1663 of file View.c.

                                                                         {
 
  assert(subview);
  assert(replacement);
 
  $(self, addSubviewRelativeTo, replacement, subview, ViewPositionAfter);
  $(self, removeSubview, subview);
}

resignKeyResponder()

void resignKeyResponder

(

View *

self

)

Resigns key responder priority.

Parameters

self

The View.

Definition at line 265 of file Control.c.

                                           {
 
  Control *this = (Control *) self;
 
  if ($(this, isHighlighted) || $(this, isFocused)) {
 
    this->state &= ~ControlStateHighlighted;
    this->state &= ~ControlStateFocused;
 
    $(this, stateDidChange);
  }
 
  super(View, self, resignKeyResponder);
}

resignTouchResponder()

void resignTouchResponder

(

View *

self

)

Resigns touch responder priority.

Parameters

self

The View.

Definition at line 1692 of file View.c.

                                             {
 
  if (self->window && $(self, isTouchResponder)) {
 
    String *path = $(self, path);
    MVC_LogDebug("%s\n", path->chars);
    release(path);
 
    SDL_SetPointerProperty(SDL_GetWindowProperties(self->window), "touchResponder", NULL);
  }
}

resize()

void resize	(	View *	self,
		const SDL_Size *	size
	)

Resizes this View to the specified size.

If the size changes, this marks this View for layout, and also its superview when that is a container or when this View has a non-None positioning alignment, since either derives from this size.

Parameters

self	The View.
size	The size to set.

Definition at line 1708 of file View.c.

                                                     {
 
  const int w = ClampSize(size->w, self->minSize.w, self->maxSize.w);
  const int h = ClampSize(size->h, self->minSize.h, self->maxSize.h);
 
  if (self->frame.w != w || self->frame.h != h) {
 
    self->frame.w = w;
    self->frame.h = h;
 
    $(self, setNeedsLayout);
    
    if (self->superview) {
      if ($(self->superview, isContainer) || self->alignment & ViewAlignmentMaskAny || self->stretch) {
        $(self->superview, setNeedsLayout);
      }
    }
  }
}

resolve()

void resolve	(	View *	self,
		Outlet *	outlets
	)

Resolves the given Outlets from this View's hierarchy.

Parameters

self	The View.
outlets	The Outlets to resolve.

Definition at line 1732 of file View.c.

                                                 {
 
  if (outlets) {
    for (Outlet *outlet = outlets; outlet->identifier; outlet++) {
      *outlet->view = $(self, descendantWithIdentifier, outlet->identifier);
      if (*outlet->view == NULL) {
        String *desc = $((Object *) self, description);
        MVC_LogError("Failed to resolve outlet '%s' for %s", outlet->identifier, desc->chars);
        release(desc);
      }
 
      assert(*outlet->view);
    }
  }
}

respondToEvent()

void respondToEvent	(	View *	self,
		const SDL_Event *	event
	)

Responds to the specified event.

Parameters

self	The View.
event	The event.

Definition at line 283 of file Control.c.

                                                               {
 
  Control *this = (Control *) self;
 
  retain(self);
 
  const ControlState state = (ControlState) this->state;
  if (!(state & ControlStateDisabled)) {
    if ($(this, captureEvent, event)) {
      if (this->state != state) {
        $(this, stateDidChange);
      }
      release(self);
      return;
    }
  }
 
  super(View, self, respondToEvent, event);
 
  release(self);
}

select()

Set * select	(	View *	self,
		const char *	rule
	)

Resolves all descendants (including this View) that match the given Selector rule.

Parameters

self	The View.
rule	The Selector rule.

Returns

The Set of selected descendant Views.

selectFirst()

View * selectFirst	(	View *	self,
		const char *	rule
	)

Resolves the first descendant View that matches the given Selector rule.

Parameters

self	The View.
rule	The Selector rule.

Returns

The matched View, or NULL.

Definition at line 1819 of file View.c.

                                                       {
 
  Selector *selector = $(alloc(Selector), initWithRule, rule);
  assert(selector);
 
  View *first = $(selector, selectFirst, self);
 
  release(selector);
  return first;
}

setNeedsApplyTheme()

void setNeedsApplyTheme

(

View *

self

)

Marks this View as needing Theme application before it is next drawn.

Parameters

self

The View.

Remarks

Callers MUST use this method rather than assigning needsApplyTheme directly: it propagates needsApplyThemeSubviews to ancestors, which View::applyThemeIfNeeded requires in order to find this View. A View flagged by direct assignment MAY be skipped.

Definition at line 1852 of file View.c.

                                           {
 
  self->needsApplyTheme = true;
 
  for (View *view = self->superview; view && !view->needsApplyThemeSubviews; view = view->superview) {
    view->needsApplyThemeSubviews = true;
  }
}

setNeedsLayout()

void setNeedsLayout

(

View *

self

)

Marks this View as needing layout before it is next drawn.

Parameters

self

The View.

Remarks

Callers MUST use this method rather than assigning needsLayout directly: it propagates needsLayoutSubviews to ancestors, which View::layoutIfNeeded requires in order to find this View. A View flagged by direct assignment MAY be skipped.

Definition at line 1865 of file View.c.

                                       {
 
  self->needsLayout = true;
 
  for (View *view = self->superview; view && !view->needsLayoutSubviews; view = view->superview) {
    view->needsLayoutSubviews = true;
  }
}

setVisibility()

void setVisibility	(	View *	self,
		ViewVisibility	visibility
	)

Sets this View's visibility.

Parameters

self	The View.
visibility	The visibility.

Remarks

Callers MUST use this method rather than assigning View::visibility directly: it marks the superview needsLayout if it is a container, and writes View::style so that the choice outlives the next Style applied.

Definition at line 1834 of file View.c.

                                                                 {
 
  if (self->visibility != visibility) {
 
    self->visibility = visibility;
 
    $(self->style, addEnumAttribute, "visibility", ViewVisibilityNames, visibility);
 
    if (self->superview && $(self->superview, isContainer)) {
      $(self->superview, setNeedsLayout);
    }
  }
}

size()

SDL_Size size

(

const View *

self

)

Parameters

self

The View.

Returns

The size of this View's frame.

Definition at line 1878 of file View.c.

                                       {
  return MakeSize(self->frame.w, self->frame.h);
}

sizeThastFills()

SDL_Size sizeThastFills

(

const View *

self

)

sizeThatContains()

SDL_Size sizeThatContains

(

const View *

self

)

Parameters

self

The View.

Returns

An SDL_Size that contains this View's subviews.

Remarks

The returned size is greater than or equal to View::sizeThatFits.

Definition at line 1886 of file View.c.

                                                   {
 
  const SDL_Size size = $(self, size);
  const SDL_Size sizeThatFits = $(self, sizeThatFits);
 
  return MakeSize(max(size.w, sizeThatFits.w), max(size.h, sizeThatFits.h));
}

sizeThatFills()

SDL_Size sizeThatFills

(

const View *

self

)

Parameters

self

The View.

Returns

An SDL_Size that fills this View's superview.

Definition at line 1898 of file View.c.

                                                {
  SDL_Size size;
 
  if (self->superview == NULL) {
    SDL_GetWindowSize(self->window, &size.w, &size.h);
  } else {
    size = $(self->superview, size);
  }
 
  return size;
}

sizeThatFits()

SDL_Size sizeThatFits

(

const View *

self

)

Parameters

self

The View.

Returns

An SDL_Size that fits this View's subviews.

Remarks

The default implementation returns this View's current size if it is not a container. If it is a container, it instead returns the smallest size that fits all of its subviews, each measured via View::sizeThatSatisfies with ViewConstraintUnspecified for both axes. Subclasses with their own sizing logic (e.g. Text, TableView) should override this method.

Definition at line 113 of file Select.c.

                                               {
 
  const Select *this = (Select *) self;
 
  SDL_Size size = super(View, self, sizeThatFits);
 
  const Array *options = (Array *) this->options;
  for (size_t i = 0; i < options->count; i++) {
 
    const View *option = $(options, objectAtIndex, i);
    const SDL_Size optionSize = $(option, sizeThatFits);
 
    size.w = max(size.w, optionSize.w + self->padding.left + self->padding.right);
    size.h = max(size.h, optionSize.h + self->padding.top + self->padding.bottom);
  }
 
  return size;
}

sizeThatSatisfies()

SDL_Size sizeThatSatisfies	(	View *	self,
		ViewConstraint	width,
		ViewConstraint	height
	)

Resolves the size this View wants to be, within the offered ViewConstraints.

Parameters

self	The View.
width	The ViewConstraint offered for this View's width.
height	The ViewConstraint offered for this View's height.

Returns

The resolved size.

Remarks

Computes this View's sizeThatFits and resolves it against the offered ViewConstraints for any axis on which this View has ViewAutoresizingWidth or ViewAutoresizingHeight set.

Definition at line 1979 of file View.c.

                                                                                           {
 
  SDL_Size size = $(self, sizeThatFits);
 
  size.w = resolveViewConstraint(self->autoresizingMask & ViewAutoresizingWidth, width, size.w);
  size.h = resolveViewConstraint(self->autoresizingMask & ViewAutoresizingHeight, height, size.h);
 
  size.w = ClampSize(size.w, self->minSize.w, self->maxSize.w);
  size.h = ClampSize(size.h, self->minSize.h, self->maxSize.h);
 
  return size;
}

sizeToContain()

void sizeToContain

(

View *

self

)

Resizes this View to contain its subviews.

Parameters

self

The View.

See also

View::sizeThatContains(const View *)

Definition at line 1996 of file View.c.

                                      {
 
  const SDL_Size size = $(self, sizeThatContains);
 
  $(self, resize, &size);
}

sizeToFill()

void sizeToFill

(

View *

self

)

Resizes this View to fill its superview.

Parameters

self

The View.

See also

View::sizeThatFills(const View *)

Definition at line 2007 of file View.c.

                                   {
 
  const SDL_Size size = $(self, sizeThatFills);
 
  $(self, resize, &size);
}

sizeToFit()

void sizeToFit

(

View *

self

)

Resizes this View to fit its subviews.

Parameters

self

The View.

See also

View::sizeThatFits(const View *)

Definition at line 2018 of file View.c.

                                  {
 
  const SDL_Size size = $(self, sizeThatFits);
 
  $(self, resize, &size);
}

sizeToSatisfy()

void sizeToSatisfy	(	View *	self,
		ViewConstraint	width,
		ViewConstraint	height
	)

Resizes this View to satisfy the given ViewConstraints.

Parameters

self	The View.
width	The ViewConstraint offered for this View's width.
height	The ViewConstraint offered for this View's height.

See also

View::sizeThatSatisfies(View *, ViewConstraint, ViewConstraint)

Definition at line 2029 of file View.c.

                                                                                   {
 
  const SDL_Size size = $(self, sizeThatSatisfies, width, height);
 
  $(self, resize, &size);
}

subviewWithIdentifier()

View * subviewWithIdentifier	(	const View *	self,
		const char *	identifier
	)

Parameters

self	The View.
identifier	The identifier.

Returns

The first subview matching the given identifier.

Definition at line 2040 of file View.c.

                                                                             {
 
  assert(identifier);
 
  const Array *subviews = (Array *) self->subviews;
  for (size_t i = 0; i < subviews->count; i++) {
 
    View *subview = subviews->elements[i];
    if (subview->identifier) {
 
      if (strcmp(identifier, subview->identifier) == 0) {
        return subview;
      }
    }
  }
 
  return NULL;
}

updateBindings()

void updateBindings	(	View *	self,
		ident	data
	)

Updates data bindings, prompting the appropriate layout changes.

The default implementation recurses over this View's subviews, passing data through unchanged. Subclasses SHOULD override this method to refresh any data sources they rely on, and MUST call super to continue the recursion.

Parameters

self	The View.
data	Application-defined data, or NULL.

Remarks

The framework always passes NULL: on ViewController::addChildViewController and on pixel density changes, meaning "refresh from configuration." An application MAY pass its own data to hand transient state – a simulation frame, say – to an entire View hierarchy at once, without holding a reference to every View that consumes it. Since a non-NULL payload MAY arrive as often as every frame, expensive work SHOULD stay behind the NULL case.

Definition at line 117 of file HSVColorPicker.c.

                                                   {
 
  super(View, self, updateBindings, data);
 
  HSVColorPicker *this = (HSVColorPicker *) self;
 
  $(this->hueSlider, setValue, this->hue);
  $(this->saturationSlider, setValue, this->saturation);
  $(this->valueSlider, setValue, this->value);
 
  const SDL_Color color = $(this, rgbColor);
  $(this->colorView->style, addColorAttribute, "background-color", &color);
  $(this->colorView, invalidateStyle);
}

viewport()

SDL_Rect viewport

(

const View *

self

)

Parameters

self

The View.

Returns

The OpenGL viewport for this View.

Definition at line 2078 of file View.c.

                                           {
 
  assert(self->window);
 
  const SDL_Rect frame =  $(self, renderFrame);
 
  return MVC_TransformToWindow(self->window, &frame);
}

viewWithCharacters()

View * viewWithCharacters	(	const char *	chars,
		Outlet *	outlets
	)

Instantiates a View initialized with the given null-terminated JSON C string.

Parameters

chars	A null-terminated JSON C string describing a View.
outlets	An optional array of Outlets to resolve.

Returns

The initialized View, or NULL on error.

Definition at line 2091 of file View.c.

                                                                    {
 
  Data *data = $$(Data, dataWithConstMemory, (ident) chars, strlen(chars));
 
  View *view = $$(View, viewWithData, data, outlets);
 
  release(data);
 
  return view;
}

viewWithData()

View * viewWithData	(	const Data *	data,
		Outlet *	outlets
	)

Instantiates a View initialized with the contents of data.

Parameters

data	A Data containing JSON describing a View.
outlets	An optional array of Outlets to resolve.

Returns

The initialized View, or NULL on error.

Definition at line 2106 of file View.c.

                                                             {
 
  JSONContext *ctx = $(alloc(JSONContext), init);
  Dictionary *dictionary = $(ctx, objectFromData, data, 0);
 
  View *view = NULL;
  if (dictionary) {
    view = $$(View, viewWithDictionary, dictionary, outlets);
    release(dictionary);
  } else {
    MVC_LogError("Failed to parse JSON\n");
  }
 
  release(ctx);
  return view;
}

viewWithDictionary()

View * viewWithDictionary	(	const Dictionary *	dictionary,
		Outlet *	outlets
	)

Instantiates a View initialized with the attributes described in dictionary.

Parameters

dictionary	A Dictionary describing a View.
outlets	An optional array of Outlets to resolve.

Returns

The initialized View, or NULL on error.

See also

View::initWithDictionary(View *, const Dictionary *, Outlet *outlets)

Definition at line 2127 of file View.c.

                                                                               {
 
  View *view = NULL;
 
  BindInlet(&MakeInlet(NULL, InletTypeView, &view, NULL), dictionary);
 
  $(view, resolve, outlets);
 
  return view;
}

viewWithResource()

View * viewWithResource	(	const Resource *	resource,
		Outlet *	outlets
	)

Instantiates a View initialized with the JSON data in resource.

Parameters

resource	A Resource containing JSON describing a View.
outlets	An optional array of Outlets to resolve.

Returns

The initialized View, or NULL on error.

See also

View::initWithData(View *, const Data *, Outlet *outlets)

Definition at line 2142 of file View.c.

                                                                         {
 
  assert(resource);
 
  return $$(View, viewWithData, resource->data, outlets);
}

viewWithResourceName()

View * viewWithResourceName	(	const char *	name,
		Outlet *	outlets
	)

Instantiates a View initialized with the JSON Resource with the specified name.

Parameters

name	The name of a JSON Resource describing a View.
outlets	An optional array of Outlets to resolve.

Returns

The initialized View, or NULL on error.

See also

View::initWithResource(View *, const Dictionary *, Outlet *outlets)

Definition at line 2153 of file View.c.

                                                                     {
 
  Resource *resource = $$(Resource, resourceWithName, name);
 
  View *view = $$(View, viewWithResource, resource, outlets);
 
  release(resource);
 
  return view;
}

visibleSubviews()

Array * visibleSubviews

(

const View *

self

)

Parameters

self

The View.

Returns

An Array of this View's visible subviews.

Remarks

The returned Array excludes that specify ViewAlignmentInternal.

Definition at line 92 of file PageView.c.

                                                {
  return $$(Array, arrayWithArray, (Array *) self->subviews);
}

warn() [1/2]

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

warn() [2/2]

void warn	(	View *	self,
		WarningType	level,
		const char *	fmt,
			...
	)

Appends a warning for this View.

Parameters

self	The View.
level	The WarningType.
fmt	The format string.

Definition at line 2186 of file View.c.

                                                                     {
 
  va_list args;
  va_start(args, fmt);
 
  Warning *warning = $(alloc(Warning), initWithVaList, type, fmt, args);
 
  va_end(args);
 
  String *description = $((Object *) self, description);
  MVC_LogWarn("%s:: %s\n", description->chars, warning->message->chars);
  release(description);
 
  $(self->warnings, addObject, warning);
 
  release(warning);
}

willMoveToWindow()

void willMoveToWindow	(	View *	self,
		SDL_Window *	window
	)

Informs this View that it will be added to the View hierarchy for the given window.

Parameters

self	The View.
window	The window, or NULL if this View will be removed from the window.

Definition at line 2208 of file View.c.

                                                             {
 
  if (self->window) {
    $(self, resignKeyResponder);
    $(self, resignTouchResponder);
    $(self, detachStylesheet, self->window);
  }
}

Field Documentation

alignment

ViewAlignment View::alignment

The alignment.

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 242 of file View.h.

autoresizingMask

int View::autoresizingMask

The ViewAutoresizing bitmask.

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 248 of file View.h.

backgroundColor

SDL_Color View::backgroundColor

The background color.

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 254 of file View.h.

backgroundGradientAngle

int View::backgroundGradientAngle

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

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 261 of file View.h.

backgroundGradientColor

SDL_Color View::backgroundGradientColor

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

Remarks

The gradient is drawn only when this color has a non-zero alpha; otherwise the background is a flat View::backgroundColor.

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 269 of file View.h.

borderColor

SDL_Color View::borderColor

The border color.

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 275 of file View.h.

borderRadius

int View::borderRadius

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

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 281 of file View.h.

borderWidth

int View::borderWidth

The border width.

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 287 of file View.h.

classNames

Set* View::classNames

The class names.

See also

Style

Definition at line 293 of file View.h.

clipsSubviews

bool View::clipsSubviews

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

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 309 of file View.h.

computedStyle

Style* View::computedStyle

The computed Style of this View.

Definition at line 314 of file View.h.

cornerCut

ViewCornerCut View::cornerCut

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

Remarks

A View with any corner inset is drawn as a polygon rather than through the rounded rectangle shader, so View::borderRadius does not apply to it.

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 322 of file View.h.

frame

SDL_Rect View::frame

The frame, relative to the superview.

Definition at line 301 of file View.h.

generation

unsigned View::generation

Definition at line 302 of file View.h.

identifier

char* View::identifier

An optional identifier.

Remarks

Identifiers are commonly used to resolve Outlets when loading Views via JSON.

Definition at line 333 of file View.h.

interface

ViewInterface* View::interface[0]

protected

The interface type.

Definition at line 236 of file View.h.

maxSize

SDL_Size View::maxSize

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

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 339 of file View.h.

minSize

SDL_Size View::minSize

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

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 345 of file View.h.

needsApplyTheme

bool View::needsApplyTheme

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

Remarks

Set this via View::setNeedsApplyTheme, which propagates needsApplyThemeSubviews to ancestors; a direct write does not, and the View MAY be skipped by View::applyThemeIfNeeded.

Definition at line 353 of file View.h.

needsLayout

bool View::needsLayout

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

Remarks

Set this via View::setNeedsLayout, which propagates needsLayoutSubviews to ancestors; a direct write does not, and the View MAY be skipped by View::layoutIfNeeded.

Definition at line 377 of file View.h.

nextResponder

View* View::nextResponder

The next responder, or event handler, in the chain.

Remarks

By default, Views propagate events to their superview. If this member is not NULL, events will instead be propagated to this View.

Definition at line 392 of file View.h.

object

Object View::object

The superclass.

Definition at line 230 of file View.h.

padding

ViewPadding View::padding

The padding.

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 398 of file View.h.

pointerEvents

ViewPointerEvents View::pointerEvents

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

Remarks

An overlay that is drawn but never interacted with, such as a full-window HUD or console layer stacked above interactive content, SHOULD be none so that clicks pass through it to whatever lies beneath. Styled as pointer-events.

See also

View::hitTest(const View *, const SDL_Point *)

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 408 of file View.h.

stretch

bool View::stretch

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

Remarks

A StackView gives each subview the size of its content along its axis. The subviews that stretch share whatever remains of the StackView's bounds, so that one child, such as a page beneath a row of tabs, can fill a StackView that is itself sized by its superview. Outside of a StackView, this has no effect. Styled as stretch.

See also

StackView::layoutSubviews(View *)

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 436 of file View.h.

style

Style* View::style

The element-level Style of this View.

Remarks

Attributes in this Style are local to this View, and override any Attributes matched via Selector. That is, it is always the last Style added to the computed Style.

Definition at line 425 of file View.h.

stylesheet

Stylesheet* View::stylesheet

An optional Stylesheet.

Remarks

If set, this Stylesheet is added to or removed from the current Theme when this View is added to or removed from a valid View hierarchy.

Definition at line 443 of file View.h.

subviews

Array* View::subviews

The immediate subviews.

Definition at line 448 of file View.h.

superview

View* View::superview

The super View.

Remarks

This reference is not retained.

Definition at line 454 of file View.h.

viewController

ViewController* View::viewController

The ViewController.

Remarks

This is NULL unless the View is the immediate view of a ViewController.

Definition at line 460 of file View.h.

visibility

ViewVisibility View::visibility

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

Remarks

unspecified is visible.

See also

View::setVisibility(View *, ViewVisibility)

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 468 of file View.h.

warnings

Array* View::warnings

The Warnings this View generated.

Remarks

These are optionally displayed by the DebugViewController.

Definition at line 474 of file View.h.

window

SDL_Window* View::window

The window.

Remarks

This is NULL until the View has been added to a WindowController.

Definition at line 480 of file View.h.

---

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

• Sources/ObjectivelyMVC/View.h
• Sources/ObjectivelyMVC/Control.c
• Sources/ObjectivelyMVC/TextView.c
• Sources/ObjectivelyMVC/View.c