TabView Struct Reference

TabViews allow for the display of multiple pages of information within a single view. More...

#include <TabView.h>

Inheritance diagram for TabView:

Public Member Functions
Class *	_TabView (void)
	The TabView archetype. More...
void	addTab (TabView *self, TabViewItem *tab)
	Adds the specified TabViewItem to this TabView. More...
TabView *	initWithFrame (TabView *self, const SDL_Rect *frame)
	Initializes this TabView with the specified frame. More...
void	removeTab (TabView *self, TabViewItem *tab)
	Removes the specified TabViewItem from this TabView. More...
void	selectTab (TabView *self, TabViewItem *tab)
	Selects the specified TabViewItem. More...
TabViewItem *	tabWithIdentifier (const TabView *self, const char *identifier)
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
TabViewDelegate	delegate
	The TabViewDelegate. More...
TabViewItem *	selectedTab
	The selected TabViewItem. More...
StackView	stackView
	The superclass. More...
PageView *	tabPageView
	The tab content container. More...
MutableArray *	tabs
	The TabViewItems. More...
StackView *	tabSelectionView
	The tab selection container. 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
TabViewInterface *	interface
	The interface. More...
Protected Attributes inherited from View
ViewInterface *	interface
	The interface. More...

Detailed Description

TabViews allow for the display of multiple pages of information within a single view.

Definition at line 79 of file TabView.h.

Member Function Documentation

_TabView()

Class * _TabView

(

void

)

The TabView archetype.

Returns

The TabView Class.

Definition at line 301 of file TabView.c.

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

addTab()

void addTab	(	TabView *	self,
		TabViewItem *	tab
	)

Adds the specified TabViewItem to this TabView.

Parameters

self	The TabView.
tab	The TabViewItem.

Definition at line 131 of file TabView.c.

                                                    {
 
    assert(tab);
 
    $(self->tabs, addObject, tab);
 
    $((View *) self->tabSelectionView, addSubview, (View *) tab->label);
    $((View *) self->tabPageView, addSubview, tab->view);
 
    if (self->delegate.didAddTab) {
        self->delegate.didAddTab(self, tab);
    }
 
    if (self->selectedTab == NULL) {
        $(self, selectTab, tab);
    }
}

initWithFrame()

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

Initializes this TabView with the specified frame.

Parameters

self	The TabView.
frame	The frame.

Returns

The initialized TabView, or NULL on error.

Definition at line 153 of file TabView.c.

                                                                    {
 
    self = (TabView *) super(StackView, self, initWithFrame, frame);
    if (self) {
 
        self->tabPageView = $(alloc(PageView), initWithFrame, NULL);
        assert(self->tabPageView);
 
        self->tabs = $$(MutableArray, array);
        assert(self->tabs);
 
        self->tabSelectionView = $(alloc(StackView), initWithFrame, NULL);
        assert(self->tabSelectionView);
 
        $((View *) self->tabSelectionView, addClassName, "tabSelectionView");
        $((View *) self, addSubview, (View *) self->tabSelectionView);
 
        $((View *) self->tabPageView, addClassName, "tabPageView");
        $((View *) self, addSubview, (View *) self->tabPageView);
    }
 
    return self;
}

removeTab()

void removeTab	(	TabView *	self,
		TabViewItem *	tab
	)

Removes the specified TabViewItem from this TabView.

Parameters

self	The TabView.
tab	The TabViewItem.

Definition at line 181 of file TabView.c.

                                                       {
 
    assert(tab);
 
    if (self->delegate.willRemoveTab) {
        self->delegate.willRemoveTab(self, tab);
    }
 
    retain(tab);
 
    $(self->tabs, removeObject, tab);
 
    $((View *) self->tabSelectionView, removeSubview, (View *) tab->label);
    $((View *) self->tabPageView, removeSubview, tab->view);
 
    if (self->selectedTab == tab) {
        $(self, selectTab, NULL);
    }
 
    release(tab);
}

selectTab()

void selectTab	(	TabView *	self,
		TabViewItem *	tab
	)

Selects the specified TabViewItem.

Parameters

self	The TabView.
tab	The TabViewItem.

Definition at line 225 of file TabView.c.

                                                       {
 
    if (self->selectedTab != tab) {
 
        const Array *tabs = (Array *) self->tabs;
 
        if (tab) {
            self->selectedTab = tab;
        } else {
            self->selectedTab = $(tabs, firstObject);
        }
 
        $(tabs, enumerateObjects, selectTab_enumerate, self);
 
        if (self->selectedTab) {
            $(self->tabPageView, setCurrentPage, self->selectedTab->view);
 
            if (self->delegate.didSelectTab) {
                self->delegate.didSelectTab(self, self->selectedTab);
            }
        }
 
        self->stackView.view.needsLayout = true;
    }
}

tabWithIdentifier()

TabViewItem * tabWithIdentifier	(	const TabView *	self,
		const char *	identifier
	)

Parameters

self	The TabView.
identifier	The identifier of the desired TabViewItem.

Returns

The TabViewItem with the specified identifier.

Definition at line 273 of file TabView.c.

                                                                                   {
    return $((Array *) self->tabs, findObject, tabWithIdentifier_predicate, (ident) identifier);
}

Field Documentation

delegate

TabViewDelegate TabView::delegate

The TabViewDelegate.

Definition at line 95 of file TabView.h.

interface

TabViewInterface* TabView::interface

protected

The interface.

Definition at line 90 of file TabView.h.

selectedTab

TabViewItem* TabView::selectedTab

The selected TabViewItem.

Definition at line 100 of file TabView.h.

stackView

StackView TabView::stackView

The superclass.

Definition at line 84 of file TabView.h.

tabPageView

PageView* TabView::tabPageView

The tab content container.

Definition at line 105 of file TabView.h.

tabs

MutableArray* TabView::tabs

The TabViewItems.

Definition at line 115 of file TabView.h.

tabSelectionView

StackView* TabView::tabSelectionView

The tab selection container.

Definition at line 110 of file TabView.h.

---

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

• Sources/ObjectivelyMVC/TabView.h
• Sources/ObjectivelyMVC/TabView.c