ViewController Struct Reference

A ViewController manages a View and its descendants. More...

#include <ViewController.h>

Inheritance diagram for ViewController:

Public Member Functions
Class *	_ViewController (void)
	The ViewController archetype.
void	addChildViewController (ViewController *self, ViewController *childViewController)
	Adds the specified child ViewController to this ViewController.
ViewController *	init (ViewController *self)
	Initializes this ViewController.
void	loadView (ViewController *self)
	Loads this ViewController's View.
void	loadViewIfNeeded (ViewController *self)
	Loads this ViewController's View if it is not already loaded.
void	moveToParentViewController (ViewController *self, ViewController *parentViewController)
	Moves this ViewController to the specified parent.
void	removeChildViewController (ViewController *self, ViewController *childViewController)
	Removes the specified child ViewController from this ViewController.
void	removeFromParentViewController (ViewController *self)
	Removes this ViewController from its parent.
void	renderDeviceDidReset (ViewController *self)
	Informs this ViewController that the render device has reset.
void	renderDeviceWillReset (ViewController *self)
	Informs this ViewController that the render device will reset.
void	respondToEvent (ViewController *self, const SDL_Event *event)
	Responds to the given event.
void	setView (ViewController *self, View *view)
	Sets this ViewController's View.
void	viewDidAppear (ViewController *self)
	This method is invoked after this ViewController's View is added to the View hierarchy.
void	viewDidDisappear (ViewController *self)
	This method is invoked after this ViewController's View is removed to the View hierarchy.
void	viewWillAppear (ViewController *self)
	This method is invoked before this ViewController's View is added to the View hierarchy.
void	viewWillDisappear (ViewController *self)
	This method is invoked before this ViewController's View is removed from the View hierarchy.

Data Fields
Array *	childViewControllers
	The child view controllers.
ViewControllerInterface *	interface
	The interface.
Object	object
	The superclass.
ViewController *	parentViewController
	The parent view controller.
View *	view
	The main view.

Detailed Description

A ViewController manages a View and its descendants.

Definition at line 52 of file ViewController.h.

Member Function Documentation

_ViewController()

Class * _ViewController

(

void

)

The ViewController archetype.

Returns

The ViewController Class.

Definition at line 335 of file ViewController.c.

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

addChildViewController()

void addChildViewController	(	ViewController *	self,
		ViewController *	childViewController
	)

Adds the specified child ViewController to this ViewController.

Parameters

self	The ViewController.
childViewController	The child ViewController.

Definition at line 66 of file TabViewController.c.

                                                                                              {
 
  super(ViewController, self, addChildViewController, childViewController);
 
  TabViewController *this = (TabViewController *) self;
 
  TabViewItem *tab = $(alloc(TabViewItem), initWithView, childViewController->view);
 
  $(this->tabView, addTab, tab);
 
  release(tab);
}

init()

ViewController * init

(

ViewController *

self

)

Initializes this ViewController.

Parameters

self	The ViewController.

Returns

The intialized ViewController, or NULL on error.

Definition at line 83 of file ViewController.c.

                                                  {
 
  self = (ViewController *) super(Object, self, init);
  if (self) {
    self->childViewControllers = $$(Array, arrayWithCapacity, 0);
    assert(self->childViewControllers);
  }
 
  return self;
}

loadView()

void loadView

(

ViewController *

self

)

Loads this ViewController's View.

Parameters

self	The ViewController.

Remarks

Override this method to populate this ViewController's view.

Definition at line 182 of file DebugViewController.c.

                                           {
 
  super(ViewController, self, loadView);
 
  DebugViewController *this = (DebugViewController *) self;
 
  Outlet outlets[] = MakeOutlets(
    MakeOutlet("statistics", &this->statistics),
    MakeOutlet("description", &this->description),
    MakeOutlet("path", &this->path),
    MakeOutlet("selectors", &this->selectors),
    MakeOutlet("computedStyle", &this->computedStyle),
    MakeOutlet("warnings", &this->warnings)
  );
 
  View *view = $$(View, viewWithCharacters, (char *) debug_json, outlets);
  view->stylesheet = $$(Stylesheet, stylesheetWithCharacters, (char *) debug_css);
 
  $(self, setView, view);
  release(view);
 
  this->selectors->dataSource.self = self;
  this->selectors->dataSource.numberOfRows = selectors_numberOfRows;
  this->selectors->dataSource.valueForColumnAndRow = selectors_valueForColumnAndRow;
  this->selectors->delegate.self = self;
  this->selectors->delegate.cellForColumnAndRow = selectors_cellForColumnAndRow;
 
  this->computedStyle->dataSource.self = self;
  this->computedStyle->dataSource.numberOfRows = computedStyle_numberOfRows;
  this->computedStyle->dataSource.valueForColumnAndRow = computedStyle_valueForColumnAndRow;
  this->computedStyle->delegate.self = self;
  this->computedStyle->delegate.cellForColumnAndRow = computedStyle_cellForColumnAndRow;
 
  this->warnings->dataSource.self = self;
  this->warnings->dataSource.numberOfRows = warnings_numberOfRows;
  this->warnings->dataSource.valueForColumnAndRow = warnings_valueForColumnAndRow;
  this->warnings->delegate.self = self;
  this->warnings->delegate.cellForColumnAndRow = warnings_cellForColumnAndRow;
}

loadViewIfNeeded()

void loadViewIfNeeded

(

ViewController *

self

)

Loads this ViewController's View if it is not already loaded.

Parameters

self	The ViewController.

Definition at line 113 of file ViewController.c.

                                                   {
 
  if (self->view == NULL) {
    $(self, loadView);
  }
 
  assert(self->view);
  assert(self->view->viewController == self);
}

moveToParentViewController()

void moveToParentViewController	(	ViewController *	self,
		ViewController *	parentViewController
	)

Moves this ViewController to the specified parent.

Parameters

self	The ViewController.
parentViewController	The parent ViewController, or NULL.

Definition at line 127 of file ViewController.c.

                                                                                                   {
 
  ViewController *this = retain(self);
 
  $(self, removeFromParentViewController);
 
  if (parentViewController) {
    $(parentViewController, addChildViewController, self);
  }
 
  release(this);
}

removeChildViewController()

void removeChildViewController	(	ViewController *	self,
		ViewController *	childViewController
	)

Removes the specified child ViewController from this ViewController.

Parameters

self	The ViewController.
childViewController	The child ViewController.

Definition at line 82 of file TabViewController.c.

                                                                                                 {
 
  super(ViewController, self, removeChildViewController, childViewController);
 
  TabViewController *this = (TabViewController *) self;
 
  TabViewItem *tab = $(this, tabForViewController, childViewController);
 
  $(this->tabView, removeTab, tab);
}

removeFromParentViewController()

void removeFromParentViewController

(

ViewController *

self

)

Removes this ViewController from its parent.

Parameters

self	The ViewController.

Definition at line 165 of file ViewController.c.

                                                                 {
 
  if (self->parentViewController) {
    $(self->parentViewController, removeChildViewController, self);
  }
}

renderDeviceDidReset()

void renderDeviceDidReset

(

ViewController *

self

)

Informs this ViewController that the render device has reset.

Parameters

self	The ViewController.

Remarks

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

Definition at line 198 of file ViewController.c.

                                                       {
  
  $(self->view, renderDeviceDidReset);
  
  $((Array *) self->childViewControllers, enumerate, renderDeviceDidReset_enumerate, NULL);
}

renderDeviceWillReset()

void renderDeviceWillReset

(

ViewController *

self

)

Informs this ViewController that the render device will reset.

Parameters

self	The ViewController.

Remarks

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

Definition at line 216 of file ViewController.c.

                                                        {
  
  $(self->view, renderDeviceWillReset);
  
  $((Array *) self->childViewControllers, enumerate, renderDeviceWillReset_enumerate, NULL);
}

respondToEvent()

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

Responds to the given event.

Parameters

self	The ViewController.
event	The event.

Definition at line 183 of file ViewController.c.

                                                                         {
  $((Array *) self->childViewControllers, enumerate, respondToEvent_enumerate, (ident) event);
}

setView()

void setView	(	ViewController *	self,
		View *	view
	)

Sets this ViewController's View.

Parameters

self	The ViewController.
view	The View.

Definition at line 227 of file ViewController.c.

                                                      {
 
  if (view != self->view) {
 
    if (self->view) {
      self->view->viewController = NULL;
      release(self->view);
    }
 
    if (view) {
      self->view = retain(view);
      self->view->viewController = self;
    } else {
      self->view = NULL;
    }
  }
}

viewDidAppear()

void viewDidAppear

(

ViewController *

self

)

This method is invoked after this ViewController's View is added to the View hierarchy.

Parameters

self	The ViewController.

Remarks

The default implementation of this method does nothing.

Definition at line 256 of file ViewController.c.

                                                {
  $((Array *) self->childViewControllers, enumerate, viewDidAppear_enumerate, NULL);
}

viewDidDisappear()

void viewDidDisappear

(

ViewController *

self

)

This method is invoked after this ViewController's View is removed to the View hierarchy.

Parameters

self	The ViewController.

Remarks

The default implementation of this method does nothing.

Definition at line 271 of file ViewController.c.

                                                   {
  $((Array *) self->childViewControllers, enumerate, viewDidDisappear_enumerate, NULL);
}

viewWillAppear()

void viewWillAppear

(

ViewController *

self

)

This method is invoked before this ViewController's View is added to the View hierarchy.

Parameters

self	The ViewController.

Remarks

The default implementation of this method does nothing.

Definition at line 286 of file ViewController.c.

                                                 {
  $((Array *) self->childViewControllers, enumerate, viewWillAppear_enumerate, NULL);
}

viewWillDisappear()

void viewWillDisappear

(

ViewController *

self

)

This method is invoked before this ViewController's View is removed from the View hierarchy.

Parameters

self	The ViewController.

Remarks

The default implementation of this method does nothing.

Definition at line 301 of file ViewController.c.

                                                    {
  $((Array *) self->childViewControllers, enumerate, viewWillDisappear_enumerate, NULL);
}

Field Documentation

childViewControllers

Array* ViewController::childViewControllers

The child view controllers.

Definition at line 67 of file ViewController.h.

interface

ViewControllerInterface* ViewController::interface

The interface.

Definition at line 62 of file ViewController.h.

object

Object ViewController::object

The superclass.

Definition at line 57 of file ViewController.h.

parentViewController

ViewController* ViewController::parentViewController

The parent view controller.

Definition at line 72 of file ViewController.h.

view

View* ViewController::view

The main view.

Definition at line 77 of file ViewController.h.

---

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

• Sources/ObjectivelyMVC/ViewController.h
• Sources/ObjectivelyMVC/ViewController.c