ObjectivelyMVC
Object oriented MVC framework for SDL3 and GNU C
Loading...
Searching...
No Matches
TabView.c
Go to the documentation of this file.
1/*
2 * ObjectivelyMVC: Object oriented MVC framework for SDL3 and C.
3 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
4 *
5 * This software is provided 'as-is', without any express or implied
6 * warranty. In no event will the authors be held liable for any damages
7 * arising from the use of this software.
8 *
9 * Permission is granted to anyone to use this software for any purpose,
10 * including commercial applications, and to alter it and redistribute it
11 * freely, subject to the following restrictions:
12 *
13 * 1. The origin of this software must not be misrepresented; you must not
14 * claim that you wrote the original software. If you use this software
15 * in a product, an acknowledgment in the product documentation would be
16 * appreciated but is not required.
17 *
18 * 2. Altered source versions must be plainly marked as such, and must not be
19 * misrepresented as being the original software.
20 *
21 * 3. This notice may not be removed or altered from any source distribution.
22 */
23
24#include <assert.h>
25#include <string.h>
26
27#include <Objectively/String.h>
28
29#include "TabView.h"
30
31#define _Class _TabView
32
33#pragma mark - Object
34
38static void dealloc(Object *self) {
39
40 TabView *this = (TabView *) self;
41
42 memset(&this->delegate, 0, sizeof(this->delegate));
43
44 release(this->tabPageView);
45 release(this->tabSelectionView);
46 release(this->tabs);
47
48 super(Object, self, dealloc);
49}
50
51#pragma mark - View
52
56static void awakeWithDictionary_tabs(const Array *array, ident obj, ident data) {
57
58 const String *identifier = $((Dictionary *) obj, objectForKeyPath, "identifier");
59 assert(identifier);
60
61 TabViewItem *tab = $(alloc(TabViewItem), initWithIdentifier, identifier->chars);
62 assert(tab);
63
64 const Inlet inlets[] = MakeInlets(
65 MakeInlet("label", InletTypeView, &tab->label, NULL),
66 MakeInlet("view", InletTypeView, &tab->view, NULL)
67 );
68
69 $((View *) data, bind, inlets, obj);
70 $((TabView *) data, addTab, tab);
71
72 release(tab);
73}
74
78static void awakeWithDictionary(View *self, const Dictionary *dictionary) {
79
80 super(View, self, awakeWithDictionary, dictionary);
81
82 TabView *this = (TabView *) self;
83
84 const Inlet inlets[] = MakeInlets(
85 MakeInlet("tabPageView", InletTypeView, &this->tabPageView, NULL),
86 MakeInlet("tabSelectionView", InletTypeView, &this->tabSelectionView, NULL)
87 );
88
89 $(self, bind, inlets, dictionary);
90
91 const Array *tabs = $(dictionary, objectForKeyPath, "tabs");
92 if (tabs) {
93 $(tabs, enumerate, awakeWithDictionary_tabs, self);
94 }
95}
96
100static View *init(View *self) {
101 return (View *) $((TabView *) self, initWithFrame, NULL);
102}
103
107static void respondToEvent(View *self, const SDL_Event *event) {
108
109 if (event->type == SDL_EVENT_MOUSE_BUTTON_UP) {
110
111 TabView *this = (TabView *) self;
112
113 const Array *tabs = (Array *) this->tabs;
114 for (size_t i = 0; i < tabs->count; i++) {
115
116 TabViewItem *tab = $(tabs, objectAtIndex, i);
117
118 if (tab->state & TabStateDisabled) {
119 continue;
120 }
121
122 if ($((View *) tab->label, didReceiveEvent, event)) {
123 $(this, selectTab, tab);
124 }
125 }
126 }
127
128 super(View, self, respondToEvent, event);
129}
130
131#pragma mark - TabView
132
137static void addTab(TabView *self, TabViewItem *tab) {
138
139 assert(tab);
140
141 $(self->tabs, addObject, tab);
142
143 $((View *) self->tabSelectionView, addSubview, (View *) tab->label);
144 $((View *) self->tabPageView, addSubview, tab->view);
145
146 if (self->delegate.didAddTab) {
147 self->delegate.didAddTab(self, tab);
148 }
149
150 if (self->selectedTab == NULL) {
151 $(self, selectTab, tab);
152 }
153}
154
159static TabView *initWithFrame(TabView *self, const SDL_Rect *frame) {
160
161 self = (TabView *) super(StackView, self, initWithFrame, frame);
162 if (self) {
163
164 self->tabPageView = $(alloc(PageView), initWithFrame, NULL);
165 assert(self->tabPageView);
166
167 self->tabs = $$(Array, array);
168 assert(self->tabs);
169
170 self->tabSelectionView = $(alloc(StackView), initWithFrame, NULL);
171 assert(self->tabSelectionView);
172
173 $((View *) self->tabSelectionView, addClassName, "tabSelectionView");
174 $((View *) self, addSubview, (View *) self->tabSelectionView);
175
176 $((View *) self->tabPageView, addClassName, "tabPageView");
177 $((View *) self, addSubview, (View *) self->tabPageView);
178 }
179
180 return self;
181}
182
187static void removeTab(TabView *self, TabViewItem *tab) {
188
189 assert(tab);
190
191 if (self->delegate.willRemoveTab) {
192 self->delegate.willRemoveTab(self, tab);
193 }
194
195 retain(tab);
196
197 $(self->tabs, removeObject, tab);
198
199 $((View *) self->tabSelectionView, removeSubview, (View *) tab->label);
200 $((View *) self->tabPageView, removeSubview, tab->view);
201
202 if (self->selectedTab == tab) {
203 $(self, selectTab, NULL);
204 }
205
206 release(tab);
207}
208
212static void selectTab_enumerate(const Array *array, ident obj, ident data) {
213
214 TabViewItem *tab = obj;
215
216 int state = tab->state;
217
218 if (tab == ((TabView *) data)->selectedTab) {
219 state |= TabStateSelected;
220 } else {
221 state &= ~TabStateSelected;
222 }
223
224 $(tab, setState, state);
225}
226
231static void selectTab(TabView *self, TabViewItem *tab) {
232
233 if (self->selectedTab != tab) {
234
235 const Array *tabs = (Array *) self->tabs;
236
237 if (tab) {
238 self->selectedTab = tab;
239 } else {
240 self->selectedTab = $(tabs, firstObject);
241 }
242
243 $(tabs, enumerate, selectTab_enumerate, self);
244
245 if (self->selectedTab) {
246 $(self->tabPageView, setCurrentPage, self->selectedTab->view);
247
248 if (self->delegate.didSelectTab) {
249 self->delegate.didSelectTab(self, self->selectedTab);
250 }
251 }
252
253 self->stackView.view.needsLayout = true;
254 }
255}
256
260static bool tabWithIdentifier_predicate(const ident obj, ident data) {
261
262 const TabViewItem *tab = obj;
263
264 if (tab->identifier) {
265 if (data) {
266 return !strcmp(tab->identifier, data);
267 } else {
268 return false;
269 }
270 } else {
271 return data == NULL;
272 }
273}
274
279static TabViewItem *tabWithIdentifier(const TabView *self, const char *identifier) {
280 return $((Array *) self->tabs, find, tabWithIdentifier_predicate, (ident) identifier);
281}
282
283#pragma mark - Class lifecycle
284
288static void initialize(Class *clazz) {
289
290 ((ObjectInterface *) clazz->interface)->dealloc = dealloc;
291
292 ((ViewInterface *) clazz->interface)->awakeWithDictionary = awakeWithDictionary;
293 ((ViewInterface *) clazz->interface)->init = init;
294 ((ViewInterface *) clazz->interface)->respondToEvent = respondToEvent;
295
296 ((TabViewInterface *) clazz->interface)->addTab = addTab;
297 ((TabViewInterface *) clazz->interface)->initWithFrame = initWithFrame;
298 ((TabViewInterface *) clazz->interface)->removeTab = removeTab;
299 ((TabViewInterface *) clazz->interface)->selectTab = selectTab;
300 ((TabViewInterface *) clazz->interface)->tabWithIdentifier = tabWithIdentifier;
301}
302
307Class *_TabView(void) {
308 static Class *clazz;
309 static Once once;
310
311 do_once(&once, {
312 clazz = _initialize(&(const ClassDef) {
313 .name = "TabView",
314 .superclass = _StackView(),
315 .instanceSize = sizeof(TabView),
316 .interfaceOffset = offsetof(TabView, interface),
317 .interfaceSize = sizeof(TabViewInterface),
319 });
320 });
321
322 return clazz;
323}
324
325#undef _Class
static void setCurrentPage(PageView *self, View *currentPage)
Definition PageView.c:130
static void removeSubview(View *self, View *subview)
Definition PageView.c:72
static void addSubview(View *self, View *subview)
Definition PageView.c:49
Class * _StackView(void)
Definition StackView.c:296
static void addTab(TabView *self, TabViewItem *tab)
Definition TabView.c:137
Class * _TabView(void)
Definition TabView.c:307
static TabView * initWithFrame(TabView *self, const SDL_Rect *frame)
Definition TabView.c:159
static View * init(View *self)
Definition TabView.c:100
static void awakeWithDictionary(View *self, const Dictionary *dictionary)
Definition TabView.c:78
static void respondToEvent(View *self, const SDL_Event *event)
Definition TabView.c:107
static void awakeWithDictionary_tabs(const Array *array, ident obj, ident data)
ArrayEnumerator for awaking TabViewItems.
Definition TabView.c:56
static void removeTab(TabView *self, TabViewItem *tab)
Definition TabView.c:187
static void selectTab_enumerate(const Array *array, ident obj, ident data)
ArrayEnumerator for selectTab.
Definition TabView.c:212
static void selectTab(TabView *self, TabViewItem *tab)
Definition TabView.c:231
static bool tabWithIdentifier_predicate(const ident obj, ident data)
NULL-safe Predicate for tabWithIdentifier.
Definition TabView.c:260
static void dealloc(Object *self)
Definition TabView.c:38
static TabViewItem * tabWithIdentifier(const TabView *self, const char *identifier)
Definition TabView.c:279
static void initialize(Class *clazz)
Definition TabView.c:288
Tabbed pages within a single View.
static void setState(TabViewItem *self, int state)
Definition TabViewItem.c:93
@ TabStateSelected
Definition TabViewItem.h:41
@ TabStateDisabled
Definition TabViewItem.h:42
static TableColumn * initWithIdentifier(TableColumn *self, const char *identifier)
Definition TableColumn.c:56
@ InletTypeView
Definition View+JSON.h:139
#define MakeInlets(...)
Creates a null-termianted array of Inlets.
Definition View+JSON.h:221
#define MakeInlet(name, type, dest, data)
Creates an Inlet with the specified parameters.
Definition View+JSON.h:216
static void addClassName(View *self, const char *className)
Definition View.c:159
static bool didReceiveEvent(const View *self, const SDL_Event *event)
Definition View.c:657
static void enumerate(View *self, ViewEnumerator enumerator, ident data)
Definition View.c:738
Inlets enable inbound data binding of View attributes through JSON.
Definition View+JSON.h:155
PageViews manage their subviews as pages in a book.
Definition PageView.h:60
StackViews are containers that manage the arrangement of their subviews.
Definition StackView.h:68
View view
The superclass.
Definition StackView.h:73
void(* didAddTab)(TabView *tabView, TabViewItem *tab)
Called when a tab is added.
Definition TabView.h:57
void(* didSelectTab)(TabView *tabView, TabViewItem *tab)
Called when a tab is selected.
Definition TabView.h:64
void(* willRemoveTab)(TabView *tabView, TabViewItem *tab)
Called when a tab is to be removed.
Definition TabView.h:71
TabViews allow for the display of multiple pages of information within a single view.
Definition TabView.h:79
StackView stackView
The superclass.
Definition TabView.h:84
PageView * tabPageView
The tab content container.
Definition TabView.h:105
TabViewItem * selectedTab
The selected TabViewItem.
Definition TabView.h:100
void removeTab(TabView *self, TabViewItem *tab)
Removes the specified TabViewItem from this TabView.
Definition TabView.c:187
StackView * tabSelectionView
The tab selection container.
Definition TabView.h:110
Array * tabs
The TabViewItems.
Definition TabView.h:115
TabViewDelegate delegate
The TabViewDelegate.
Definition TabView.h:95
TabViewItems embed Views in a TabView.
Definition TabViewItem.h:52
int state
The bit mask of TabState.
Definition TabViewItem.h:78
View * view
The View this TabViewItem embeds.
Definition TabViewItem.h:83
Label * label
The Label used to select this tab.
Definition TabViewItem.h:73
char * identifier
The identifier.
Definition TabViewItem.h:68
Views are the fundamental building blocks of ObjectivelyMVC user interfaces.
Definition View.h:134
bool needsLayout
If true, this View will layout its subviews before it is drawn.
Definition View.h:222
void respondToEvent(View *self, const SDL_Event *event)
Responds to the specified event.
Definition Control.c:266