Controls are Views which capture events and dispatch Actions. More...

#include <Control.h>

Inheritance diagram for Control:

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

Array *	actionsForEvent (const Control self, const SDL_Event event)

void	addActionForEventType (Control *self, SDL_EventType eventType, ActionFunction function, ident sender, ident data)
	Adds an Action for the given event type to this Control. More...

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

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

_Bool	isDisabled (const Control *self)

_Bool	isFocused (const Control *self)

_Bool	isHighlighted (const Control *self)

_Bool	isSelected (const Control *self)

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

Public Member Functions inherited from View
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
ControlBevel	bevel
	The ControlBevel. More...

ControlSelection	selection
	The ControlSelection. More...

unsigned int	state
	The bit mask of ControlState. More...

View	view
	The superclass. More...

Data Fields inherited from View
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
ControlInterface *	interface
	The interface. More...

Protected Attributes inherited from View
ViewInterface *	interface
	The interface. More...

Detailed Description

Controls are Views which capture events and dispatch Actions.

Definition at line 83 of file Control.h.

Member Function Documentation

◆ _Control()

Class * _Control ( void )

The Control archetype.

Returns: The Control Class.

Definition at line 379 of file Control.c.

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

◆ actionsForEvent()

Array * actionsForEvent	(	const Control *	self,
		const SDL_Event *	event
	)

Parameters

self	The Control.
event	The event.

Returns: An Array of all Actions bound to the given event.

Definition at line 256 of file Control.c.

                                                                           {
    return $((Array *) self->actions, filteredArray, actionsForEvent_predicate, (ident) event);
}

◆ addActionForEventType()

void addActionForEventType	(	Control *	self,
		SDL_EventType	eventType,
		ActionFunction	function,
		ident	sender,
		ident	data
	)

Adds an Action for the given event type to this Control.

Parameters

self	The Control.
eventType	The event type.
function	The ActionFunction.
sender	The sender.
data	User data.

Definition at line 264 of file Control.c.

                                                                                                                             {
 
    Action *action = $(alloc(Action), initWithEventType, eventType, function, sender, data);
 
    $(self->actions, addObject, action);
 
    release(action);
}

◆ captureEvent()

_Bool captureEvent	(	Control *	self,
		const SDL_Event *	event
	)

Captures a given event, potentially altering the state of this Control.

Parameters

self	The Control.
event	The event.

Returns: True if the Event was captured, false otherwise.

Remarks: Subclasses should override this method to capture events.

Definition at line 76 of file Button.c.

                                                                 {
 
    if (event->type == SDL_MOUSEBUTTONDOWN) {
        self->state |= ControlStateHighlighted;
        MVC_PlaySound(_clack);
        return true;
    }
 
    if (event->type == SDL_MOUSEBUTTONUP) {
        self->state &= ~ControlStateHighlighted;
        MVC_PlaySound(_click);
        return true;
    }
 
    return super(Control, self, captureEvent, event);
}

◆ initWithFrame()

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

Initializes this Control with the specified frame and style.

Parameters

self	The Control.
frame	The frame.

Returns: The intialized Control, or NULL on error.

Definition at line 285 of file Control.c.

                                                                    {
 
    self = (Control *) super(View, self, initWithFrame, frame);
    if (self) {
 
        self->actions = $$(MutableArray, arrayWithCapacity, 0);
        assert(self->actions);
    }
 
    return self;
}

◆ isDisabled()

_Bool isDisabled ( const Control * self )

Parameters

self	The Control.

Returns: True if this Control is disabled, false otherwise.

Definition at line 301 of file Control.c.

                                             {
    return (self->state & ControlStateDisabled) == ControlStateDisabled;
}

◆ isFocused()

_Bool isFocused ( const Control * self )

Parameters

self	The Control.

Returns: True if this Control is focused, false otherwise.

Definition at line 309 of file Control.c.

                                            {
    return (self->state & ControlStateFocused) == ControlStateFocused;
}

◆ isHighlighted()

_Bool isHighlighted ( const Control * self )

Parameters

self	The Control.

Returns: True if this Control is highlighted, false otherwise.

Definition at line 317 of file Control.c.

                                                {
    return (self->state & ControlStateHighlighted) == ControlStateHighlighted;
}

◆ isSelected()

_Bool isSelected ( const Control * self )

Parameters

self	The Control.

Returns: True if this Control is selected, false otherwise.

Definition at line 325 of file Control.c.

                                             {
    return (self->state & ControlStateSelected) == ControlStateSelected;
}

◆ stateDidChange()

void stateDidChange ( Control * self )

Called when the state of this Control changes.

Parameters

self	The Control.

Remarks: Subclasses may implement this method to handle discrete state changes.

Definition at line 103 of file Checkbox.c.

                                          {
 
    super(Control, self, stateDidChange);
 
    Checkbox *this = (Checkbox *) self;
 
    if (self->state & ControlStateSelected) {
        this->check->view.hidden = false;
    } else {
        this->check->view.hidden = true;
    }
}

Field Documentation

◆ bevel

ControlBevel Control::bevel

The ControlBevel.

Definition at line 105 of file Control.h.

◆ interface

ControlInterface* Control::interface

protected

The interface.

Definition at line 94 of file Control.h.

◆ selection

ControlSelection Control::selection

The ControlSelection.

Definition at line 115 of file Control.h.

◆ state

unsigned int Control::state

The bit mask of ControlState.

Definition at line 110 of file Control.h.

◆ view

View Control::view

The superclass.

Definition at line 88 of file Control.h.

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

Sources/ObjectivelyMVC/Control.h
Sources/ObjectivelyMVC/Control.c

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Member Function Documentation

◆ _Control()

◆ actionsForEvent()

◆ addActionForEventType()

◆ captureEvent()

◆ initWithFrame()

◆ isDisabled()

◆ isFocused()

◆ isHighlighted()

◆ isSelected()

◆ stateDidChange()

Field Documentation

◆ bevel

◆ interface

◆ selection

◆ state

◆ view