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. More...
_Bool	acceptsFirstResponder (const View *self)
void	addClassName (View *self, const char *className)
	Adds the given class name to this View. More...
void	addSubview (View *self, View *subview)
	Adds a subview to this view, to be drawn above its siblings. More...
void	addSubviewRelativeTo (View *self, View *subview, View *other, ViewPosition position)
	Adds a subview to this view, positioned relatively to other. More...
	ancestorWithIdentifier (const View *self, const char *identifier)
void	applyStyle (View *self, const Style *style)
	Applies the given Style to this View. More...
void	applyTheme (View *self, const Theme *theme)
	Applies the given Theme to this View. More...
void	applyThemeIfNeeded (View *self, const Theme *theme)
	Recursively applies the Theme to this View and its subviews. More...
void	attachStylesheet (View *self, SDL_Window *window)
	Attaches this View's Stylesheet to the Theme associated with the given window. More...
void	awakeWithCharacters (View *self, const char *chars)
	Wakes this View with the given null-terminated JSON C string. More...
void	awakeWithData (View *self, const Data *data)
	Wakes this View with the specified JSON Data. More...
void	awakeWithDictionary (View *self, const Dictionary *dictionary)
	Wakes this View with the specified Dictionary. More...
void	awakeWithResource (View *self, const Resource *resource)
	Wakes this View with the specified Resource. More...
void	awakeWithResourceName (View *self, const char *name)
	Wakes this View with the Resource by the specified name. More...
void	becomeFirstResponder (View *self)
	Become the first responder in the View hierarchy. More...
_Bool	bind (View *self, const Inlet *inlets, const Dictionary *dictionary)
	Performs data binding for the Inlets described in dictionary. More...
SDL_Rect	bounds (const View *self)
void	bringSubviewToFront (View *self, View *subview)
	Brings the specified subview to the front. More...
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. More...
void	didMoveToWindow (View *self, SDL_Window *window)
	Informs this View that it has been added to the View hierachy of the given window. More...
_Bool	didReceiveEvent (const View *self, const SDL_Event *event)
void *	draw (View *self, Renderer *renderer)
	Draws this View. More...
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. More...
void	enumerateAdjacent (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates adjacent siblings of this View, applying enumerator to each. More...
void	enumerateAncestors (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all ancestors of this View, applying enumerator to each. More...
void	enumerateDescendants (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all descendants of this View, applying enumerator to each. More...
void	enumerateSelection (View *self, const char *rule, ViewEnumerator enumerator, ident data)
	Enumerates all Views in the selection matched by rule, applying enumerator to each. More...
void	enumerateSiblings (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all siblings of this View, applying enumerator to each. More...
void	enumerateSubviews (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all subviews of this View, applying enumerator to each. More...
void	enumerateSuperview (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates the superview of this View, if any, applying enumerator to it. More...
View *	firstResponder (SDL_Window *window)
_Bool	hasClassName (const View *self, cosnt char *className)
View *	hitTest (const View *self, const SDL_Point *point)
	Performs a hit test against this View and its descendants for the given point. More...
View *	init (View *self)
	Initializes this View. More...
View *	initWithFrame (View *self, const SDL_Rect *frame)
	Initializes this View with the specified frame. More...
void	invalidateStyle (View *self)
	Invalidates the computed Style for this View and its descendants. More...
_Bool	isContainer (const View *self)
_Bool	isDescendantOfView (const View *self, const View *view)
_Bool	isFirstResponder (const View *self)
_Bool	isVisible (const View *self)
void	layoutIfNeeded (View *self)
	Recursively updates the layout of this View and its subviews. More...
	layoutSubviews (View *self)
	Performs layout for this View's immediate subviews. More...
_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. More...
String *	path (const View *self)
void	removeAllClassNames (View *self)
	Removes all class names from this View. More...
void	removeAllSubviews (View *self)
	Removes all subviews from this View. More...
void	removeClassName (View *self, const char *className)
	Removes the given class name to this View. More...
void	removeFromSuperview (View *self)
	Removes this View from its superview. More...
void	removeSubview (View *self, View *subview)
	Removes the given subview from this View. More...
void	render (View *self, Renderer *renderer)
	Renders this View using the given renderer. More...
void	renderDeviceDidReset (View *self)
	Informs this View that the render device has reset. More...
void	renderDeviceWillReset (View *self)
	Informs this View that the render device will reset. More...
SDL_Rect	renderFrame (const View *self)
void	replaceSubview (View *self, View *subview, View *replacement)
	Replaces the specified subview with the given replacement. More...
void	resignFirstResponder (View *self)
	Resigns first responder priority. More...
void	resize (View *self, const SDL_Size *size)
	Resizes this View to the specified size. More...
void	resolve (View *self, Outlet *outlets)
	Resolves the given Outlets from this View's hierarchy. More...
void	respondToEvent (View *self, const SDL_Event *event)
	Responds to the specified event. More...
Set *	select (View *self, const char *rule)
	Resolves all descendants (including this View) that match the given Selector rule. More...
void	setFirstResponder (SDL_Window *window, View *view)
	Sets the first responder for the given window. More...
SDL_Size	size (const View *self)
SDL_Size	sizeThatContains (const View *self)
void	sizeThatFits (const View *self)
void	sizeToContain (View *self)
	Resizes this View to contain its subviews. More...
void	sizeToFit (View *self)
	Resizes this View to fit its subviews. More...
	subviewWithIdentifier (const View *self, const char *identifier)
void	updateBindings (View *self)
	Updates data bindings, prompting the appropriate layout changes. More...
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. More...
View *	viewWithData (const Data *data, Outlet *outlets)
	Instantiates a View initialized with the contents of data. More...
View *	viewWithDictionary (const Dictionary *dictionary, Outlet *outlets)
	Instantiates a View initialized with the attributes described in dictionary. More...
View *	viewWithResource (const Resource *resource, Outlet *outlets)
	Instantiates a View initialized with the JSON data in resource. More...
View *	viewWithResourceName (const char *name, Outlet *outlets)
	Instantiates a View initialized with the JSON Resource with the specified name. More...
Array *	visibleSubviews (const View *self)
void	warn (View *self, const char *fmt,...)
	Appends a warning for this View. More...
void	willMoveToWindow (View *self, SDL_Window *window)
	Informs this View that it will be added to the View hierarchy for the given window. More...

Data Fields
ViewAlignment	alignment
	The alignment. More...
int	autoresizingMask
	The ViewAutoresizing bitmask. More...
SDL_Color	backgroundColor
	The background color. More...
SDL_Color	borderColor
	The border color. More...
int	borderWidth
	The border width. More...
MutableSet *	classNames
	The class names. More...
_Bool	clipsSubviews
	If true, subviews will be clipped to this View's frame. More...
Style *	computedStyle
	The computed Style of this View. More...
SDL_Rect	frame
	The frame, relative to the superview. More...
_Bool	hidden
	If true, this View is not drawn. More...
char *	identifier
	An optional identifier. More...
SDL_Size	maxSize
	The maximum size this View may be resized to during layout. More...
SDL_Size	minSize
	The minimum size this View may be resized to during layout. More...
_Bool	needsApplyTheme
	If true, this View will apply the Theme before it is drawn. More...
_Bool	needsLayout
	If true, this View will layout its subviews before it is drawn. More...
View *	nextResponder
	The next responder, or event handler, in the chain. More...
Object	object
	The superclass. More...
ViewPadding	padding
	The padding. More...
Style *	style
	The element-level Style of this View. More...
Stylesheet *	stylesheet
	An optional Stylesheet. More...
MutableArray *	subviews
	The immediate subviews. More...
View *	superview
	The super View. More...
ViewController *	viewController
	The ViewController. More...
MutableArray *	warnings
	The warnings this View generated. More...
SDL_Window *	window
	The window. More...

Protected Attributes
ViewInterface *	interface
	The interface. More...

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

Member Function Documentation

_View()

Class * _View

(

void

)

The View archetype.

Returns

The View Class.

Definition at line 1769 of file View.c.

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

acceptsFirstResponder()

_Bool acceptsFirstResponder

(

const View *

self

)

Parameters

self

The View.

Returns

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

Definition at line 68 of file Control.c.

                                                     {
    return true;
}

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 120 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 35 of file PageView.c.

                                                  {
 
    super(View, self, addSubview, subview);
 
    PageView *this = (PageView *) self;
 
    subview->hidden = true;
 
    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 146 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->needsLayout = true;
}

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 188 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 56 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 246 of file View.c.

                                                       {
 
    assert(theme);
 
    Style *computedStyle = $(theme, computeStyle, self);
    assert(computedStyle);
 
    if (!$(self->computedStyle, isComputedEqual, computedStyle)) {
 
        release(self->computedStyle);
        self->computedStyle = retain(computedStyle);
 
        $(self->computedStyle, addAttributes, self->style->attributes);
        $(self, applyStyle, self->computedStyle);
    }
 
    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 269 of file View.c.

                                                               {
 
    assert(theme);
 
    if (self->needsApplyTheme) {
        $(self, applyTheme, theme);
    }
 
    self->needsApplyTheme = false;
 
    $(self, enumerateSubviews, (ViewEnumerator) applyThemeIfNeeded, (ident) theme);
}

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 286 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 302 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 315 of file View.c.

                                                        {
 
    Dictionary *dictionary = $$(JSONSerialization, objectFromData, data, 0);
 
    $(self, awakeWithDictionary, dictionary);
 
    release(dictionary);
}

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 346 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 357 of file View.c.

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

becomeFirstResponder()

void becomeFirstResponder

(

View *

self

)

Become the first responder in the View hierarchy.

Parameters

self

The View.

Remarks

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

Definition at line 370 of file View.c.

                                             {
    $$(View, setFirstResponder, self->window, 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 394 of file View.c.

                                         {
 
    const SDL_Size size = $(self, size);
 
    const SDL_Rect bounds = {
        .x = self->padding.left,
        .y = self->padding.top,
        .w = size.w - (self->padding.left + self->padding.right),
        .h = 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 412 of file View.c.

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

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 429 of file View.c.

                                                {
 
    SDL_Rect frame = $(self, renderFrame);
 
    if (self->borderWidth && self->borderColor.a) {
        for (int i = 0; i < self->borderWidth; i++) {
            frame.x -= 1;
            frame.y -= 1;
            frame.w += 2;
            frame.h += 2;
        }
    }
 
    const View *superview = self->superview;
    while (superview) {
        if (superview->clipsSubviews) {
            const SDL_Rect clippingFrame = $(superview, clippingFrame);
            if (SDL_IntersectRect(&clippingFrame, &frame, &frame) == false) {
 
                if (MVC_LogEnabled(SDL_LOG_PRIORITY_VERBOSE)) {
                    String *desc = $((Object *) self, description);
                    String *superdesc = $((Object *) superview, description);
 
                    MVC_LogVerbose("%s is clipped by %s\n", desc->chars, superdesc->chars);
 
                    release(desc);
                    release(superdesc);
                }
 
                frame.w = frame.h = 0;
                break;
            }
        }
        superview = superview->superview;
    }
 
    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 472 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 483 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 491 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, objectAtIndex, 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 517 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 533 of file View.c.

                                                            {
 
    if (window) {
        $(self, attachStylesheet, window);
 
        self->needsLayout = true;
    }
}

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 546 of file View.c.

                                                                       {
 
    if ($(self, isVisible)) {
 
        SDL_Point point;
 
        if (event->type == SDL_MOUSEBUTTONDOWN || event->type == SDL_MOUSEBUTTONUP) {
            point = MakePoint(event->button.x, event->button.y);
        } else if (event->type == SDL_MOUSEMOTION) {
            point = MakePoint(event->motion.x, event->motion.y);
        } else if (event->type == SDL_MOUSEWHEEL) {
            SDL_GetMouseState(&point.x, &point.y);
        } else {
            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 572 of file View.c.

                                                 {
 
    assert(self->window);
 
    if (self->hidden == false) {
 
        $(renderer, drawView, self);
 
        $(self, enumerateSubviews, (ViewEnumerator) draw, renderer);
    }
}

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 588 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 601 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 621 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 647 of file View.c.

                                                                                          {
 
    assert(enumerator);
 
    const Array *subviews = (Array *) self->subviews;
    for (size_t i = 0; i < subviews->count; i++) {
 
        View *subview = $(subviews, objectAtIndex, 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 634 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 665 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, objectAtIndex, 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 685 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 699 of file View.c.

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

firstResponder()

View * firstResponder

(

SDL_Window *

window

)

Parameters

window

The window.

Returns

The first responder for the given window, or NULL if none.

Definition at line 712 of file View.c.

                                                {
 
    assert(window);
 
    return SDL_GetWindowData(window, "firstResponder");
}

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.

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.

Definition at line 743 of file View.c.

                                                               {
 
    if (self->hidden == false) {
 
        if ($(self, containsPoint, point)) {
 
            const Array *subviews = (Array *) self->subviews;
            for (size_t i = subviews->count; i; i--) {
 
                const View *subview = $(subviews, objectAtIndex, i - 1);
                const View *view = $(subview, hitTest, point);
                if (view) {
                    return (View *) view;
                }
            }
 
            return (View *) self;
        }
    }
 
    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 778 of file View.c.

                                                              {
 
    self = (View *) super(Object, self, init);
    if (self) {
 
        if (frame) {
            self->frame = *frame;
        }
 
        self->classNames = $$(MutableSet, setWithCapacity, 0);
        assert(self->classNames);
 
        self->computedStyle = $(alloc(Style), initWithAttributes, NULL);
        assert(self->computedStyle);
 
        self->subviews = $$(MutableArray, arrayWithCapacity, 0);
        assert(self->subviews);
 
        self->style = $(alloc(Style), initWithAttributes, NULL);
        assert(self->style);
 
        self->warnings = $$(MutableArray, arrayWithCapacity, 0);
        assert(self->warnings);
 
        self->maxSize = MakeSize(INT32_MAX, INT32_MAX);
 
        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 822 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 830 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 838 of file View.c.

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

isFirstResponder()

_Bool isFirstResponder

(

const View *

self

)

Parameters

self

The View.

Returns

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

Definition at line 856 of file View.c.

                                                {
 
    if (self->window) {
        return $$(View, firstResponder, self->window) == 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 869 of file View.c.

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

layoutIfNeeded()

void layoutIfNeeded

(

View *

self

)

Recursively updates the layout of this View and its subviews.

Parameters

self

The View.

Definition at line 891 of file View.c.

                                       {
 
    if (self->needsLayout) {
        $(self, layoutSubviews);
 
        if (MVC_LogEnabled(SDL_LOG_PRIORITY_DEBUG)) {
 
            if (self->hidden == false && self->superview && self->superview->clipsSubviews) {
 
                const SDL_Rect bounds = $(self, bounds);
                const SDL_Rect superviewBounds = $(self->superview, bounds);
 
                if (bounds.x + bounds.w > superviewBounds.w ||
                    bounds.y + bounds.h > superviewBounds.h) {
 
                    String *this = $((Object *) self, description);
                    String *that = $((Object *) self->superview, description);
 
                    MVC_LogDebug("%s exceeds superview bounds %s\n", this->chars, that->chars);
 
                    $(self, warn, "%s exceeds superview bounds %s\n", this->chars, that->chars);
 
                    release(this);
                    release(that);
                }
            }
        }
    }
 
    self->needsLayout = false;
 
    $(self, enumerateSubviews, layoutIfNeeded_recurse, NULL);
}

layoutSubviews()

layoutSubviews

(

View *

self

)

Performs layout for this View's immediate subviews.

Parameters

self

The View.

Remarks

Subclasses may override this method to perform their own layout operations. This method is called recursively by View::layoutIfNeeded.

Definition at line 74 of file Box.c.

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

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 1073 of file View.c.

                                                         {
 
    if (self->window != window) {
 
        $(self, willMoveToWindow, window);
 
        self->window = window;
 
        $(self, didMoveToWindow, window);
 
        $(self, enumerateSubviews, moveToWindow_recurse, window);
    }
}

path()

String * path

(

const View *

self

)

Parameters

self

The view.

Returns

A unique CSS selector matching this View.

Definition at line 1091 of file View.c.

                                      {
 
    MutableArray *parts = $$(MutableArray, 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 1132 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 1150 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 1158 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 1175 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 58 of file PageView.c.

                                                     {
 
    PageView *this = (PageView *) self;
 
    retain(subview);
 
    super(View, self, removeSubview, subview);
 
    subview->hidden = false;
 
    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 131 of file Control.c.

                                                   {
 
    super(View, self, render, renderer);
 
    Control *this = (Control *) self;
 
    const SDL_Rect frame = $(self, renderFrame);
 
    if (this->bevel == ControlBevelInset) {
 
        $(renderer, setDrawColor, &Colors.Silver);
 
        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));
 
        $(renderer, setDrawColor, &Colors.Black);
 
        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));
 
    } else if (this->bevel == ControlBevelOutset) {
 
        $(renderer, setDrawColor, &Colors.Black);
 
        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));
 
        $(renderer, setDrawColor, &Colors.Silver);
 
        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));
    }
 
    if (this->state & ControlStateFocused) {
 
        $(renderer, setDrawColor, &Colors.Charcoal);
 
        $(renderer, drawRect, &frame);
    }
 
    $(renderer, setDrawColor, &Colors.White);
}

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 172 of file Text.c.

                                             {
 
    Text *this = (Text *) self;
 
    $(this->font, renderDeviceDidReset);
 
    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 121 of file ImageView.c.

                                              {
 
    ImageView *this = (ImageView *) self;
 
    if (this->texture) {
        glDeleteTextures(1, &this->texture);
    }
 
    this->texture = 0;
 
    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 1275 of file View.c.

                                              {
 
    SDL_Rect frame = self->frame;
 
    const View *view = self;
    const View *superview = view->superview;
    while (superview) {
 
        frame.x += superview->frame.x;
        frame.y += superview->frame.y;
 
        if (view->alignment != ViewAlignmentInternal) {
            frame.x += superview->padding.left;
            frame.y += superview->padding.top;
        }
 
        view = superview;
        superview = view->superview;
    }
 
    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 1302 of file View.c.

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

resignFirstResponder()

void resignFirstResponder

(

View *

self

)

Resigns first responder priority.

Parameters

self

The View.

Definition at line 1315 of file View.c.

                                             {
 
    if ($(self, isFirstResponder)) {
        $$(View, setFirstResponder, self->window, NULL);
    }
}

resize()

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

Resizes this View to the specified size.

Parameters

self	The View.
size	The size to set.

Definition at line 1326 of file View.c.

                                                     {
 
    if (self->frame.w != size->w || self->frame.h != size->h) {
 
        self->frame.w = clamp(size->w, self->minSize.w, self->maxSize.w);
        self->frame.h = clamp(size->h, self->minSize.h, self->maxSize.h);
 
        self->needsLayout = true;
 
        if (self->superview) {
            self->superview->needsLayout = true;
        }
    }
}

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 1345 of file View.c.

                                                 {
 
    if (outlets) {
        for (Outlet *outlet = outlets; outlet->identifier; outlet++) {
            *outlet->view = $(self, descendantWithIdentifier, outlet->identifier);
            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 213 of file Control.c.

                                                               {
 
    Control *this = (Control *) self;
 
    const ControlState state = this->state;
 
    const _Bool didCaptureEvent = $(this, captureEvent, event);
    if (didCaptureEvent) {
 
        const Array *actions = (Array *) this->actions;
        for (size_t i = 0; i < actions->count; i++) {
 
            const Action *action = $(actions, objectAtIndex, i);
            if (action->eventType == event->type) {
                action->function(this, event, action->sender, action->data);
            }
        }
    }
 
    if (this->state != state) {
        $(this, stateDidChange);
    }
 
    if (didCaptureEvent) {
        return;
    }
 
    super(View, self, respondToEvent, event);
}

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.

setFirstResponder()

void setFirstResponder	(	SDL_Window *	window,
		View *	view
	)

Sets the first responder for the given window.

Parameters

window	The window.
view	The View.

Definition at line 1393 of file View.c.

                                                              {
 
    assert(window);
 
    if (view) {
        assert(view->window == window);
        SDL_SetWindowData(window, "firstResponder", view);
        if (MVC_LogEnabled(SDL_LOG_PRIORITY_DEBUG)) {
            String *desc = $((Object *) view, description);
            SDL_LogDebug(LOG_CATEGORY_MVC, "%s: %s\n", __func__, desc->chars);
            release(desc);
        }
    } else {
        SDL_SetWindowData(window, "firstResponder", NULL);
        SDL_LogDebug(LOG_CATEGORY_MVC, "%s: NULL\n", __func__);
    }
}

size()

SDL_Size size

(

const View *

self

)

Parameters

self

The View.

Returns

The size of this View's frame.

Definition at line 1415 of file View.c.

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

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 1423 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));
}

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 of this method returns the View's current size, or an appropriate value based on this View's autoresizingMask.

Definition at line 123 of file CollectionView.c.

                                               {
 
    const CollectionView *this = (CollectionView *) self;
 
    return $(this, naturalSize);
}

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 1485 of file View.c.

                                      {
 
    const SDL_Size size = $(self, sizeThatContains);
 
    $(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 1496 of file View.c.

                                  {
 
    const SDL_Size size = $(self, sizeThatFits);
 
    $(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 1507 of file View.c.

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

updateBindings()

void updateBindings

(

View *

self

)

Updates data bindings, prompting the appropriate layout changes.

Parameters

self

The View.

Remarks

Subclasses should override this method to refresh any data sources they rely on.

Definition at line 115 of file HSVColorPicker.c.

                                       {
 
    super(View, self, updateBindings);
 
    HSVColorPicker *this = (HSVColorPicker *) self;
 
    $(this->hueSlider, setValue, this->hue);
    $(this->saturationSlider, setValue, this->saturation);
    $(this->valueSlider, setValue, this->value);
 
    this->colorView->backgroundColor = $(this, rgbColor);
}

viewport()

SDL_Rect viewport

(

const View *

self

)

Parameters

self

The View.

Returns

The OpenGL viewport for this View.

Definition at line 1545 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 1558 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 1573 of file View.c.

                                                             {
 
    Dictionary *dictionary = $$(JSONSerialization, objectFromData, data, 0);
 
    View *view = $$(View, viewWithDictionary, dictionary, outlets);
 
    release(dictionary);
 
    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 1588 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 1603 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 1614 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 78 of file PageView.c.

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

warn()

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

Appends a warning for this View.

Parameters

self	The View.
fmt	The format string.

Definition at line 1647 of file View.c.

                                                   {
    va_list args;
    va_start(args, fmt);
 
    String *warning = $(alloc(String), initWithVaList, fmt, args);
    assert(warning);
 
    va_end(args);
 
    $(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 1664 of file View.c.

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

Field Documentation

alignment

ViewAlignment View::alignment

The alignment.

Definition at line 149 of file View.h.

autoresizingMask

int View::autoresizingMask

The ViewAutoresizing bitmask.

Definition at line 154 of file View.h.

backgroundColor

SDL_Color View::backgroundColor

The background color.

Definition at line 159 of file View.h.

borderColor

SDL_Color View::borderColor

The border color.

Definition at line 164 of file View.h.

borderWidth

int View::borderWidth

The border width.

Definition at line 169 of file View.h.

classNames

MutableSet* View::classNames

The class names.

See also

Style

Definition at line 175 of file View.h.

clipsSubviews

_Bool View::clipsSubviews

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

Definition at line 180 of file View.h.

computedStyle

Style* View::computedStyle

The computed Style of this View.

Definition at line 185 of file View.h.

frame

SDL_Rect View::frame

The frame, relative to the superview.

Definition at line 190 of file View.h.

hidden

_Bool View::hidden

If true, this View is not drawn.

Definition at line 195 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 201 of file View.h.

interface

ViewInterface* View::interface

protected

The interface.

Definition at line 144 of file View.h.

maxSize

SDL_Size View::maxSize

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

Definition at line 206 of file View.h.

minSize

SDL_Size View::minSize

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

Definition at line 211 of file View.h.

needsApplyTheme

_Bool View::needsApplyTheme

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

Definition at line 216 of file View.h.

needsLayout

_Bool View::needsLayout

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

Definition at line 221 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 228 of file View.h.

object

Object View::object

The superclass.

Definition at line 138 of file View.h.

padding

ViewPadding View::padding

The padding.

Definition at line 233 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 240 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 247 of file View.h.

subviews

MutableArray* View::subviews

The immediate subviews.

Definition at line 252 of file View.h.

superview

View* View::superview

The super View.

Remarks

This reference is not retained.

Definition at line 258 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 264 of file View.h.

warnings

MutableArray* View::warnings

The warnings this View generated.

Remarks

These are optionally displayed by the DebugViewController.

Definition at line 270 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 276 of file View.h.

---

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

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