NavigationViewController Struct Reference

Navigation controllers arrange their child controllers as a stack to facilitate navigation between them. More...

#include <NavigationViewController.h>

Inheritance diagram for NavigationViewController:

Public Member Functions
Class *	_NavigationViewController (void)
	The NavigationViewController archetype.
NavigationViewController *	init (NavigationViewController *self)
	Initializes this NavigationViewController.
void	popToRootViewController (NavigationViewController *self)
	Pops all ViewControllers on the stack except for the root ViewController.
void	popToViewController (NavigationViewController *self, const ViewController *viewController)
	Pops the top ViewController from the stack until the specified ViewController is visible.
void	popViewController (NavigationViewController *self)
	Pops the top ViewController from the stack.
void	pushViewController (NavigationViewController *self, ViewController *viewController)
	Pushes the specified ViewController to the top of the stack.
ViewController	rootViewController (const NavigationViewController *self)
ViewController	topViewController (const NavigationViewController *self)
Public Member Functions inherited from ViewController
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
ViewController	viewController
	The superclass.
Data Fields inherited from ViewController
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.

Protected Attributes
NavigationViewControllerInterface *	interface
	The interface.

Detailed Description

Navigation controllers arrange their child controllers as a stack to facilitate navigation between them.

Definition at line 43 of file NavigationViewController.h.

Member Function Documentation

_NavigationViewController()

Class * _NavigationViewController

(

void

)

The NavigationViewController archetype.

Returns

The NavigationViewController Class.

Definition at line 150 of file NavigationViewController.c.

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

init()

NavigationViewController * init

(

NavigationViewController *

self

)

Initializes this NavigationViewController.

Parameters

self	The NavigationViewController.

Returns

The initialized NavigationViewController, or NULL on error.

Definition at line 38 of file NavigationViewController.c.

                                                                      {
 
  return (NavigationViewController *) super(ViewController, self, init);
}

popToRootViewController()

void popToRootViewController

(

NavigationViewController *

self

)

Pops all ViewControllers on the stack except for the root ViewController.

Parameters

self	The NavigationViewController.

Definition at line 68 of file NavigationViewController.c.

                                                                    {
 
  const ViewController *rootViewController = $(self, rootViewController);
  if (rootViewController) {
    $(self, popToViewController, rootViewController);
  }
}

popToViewController()

void popToViewController	(	NavigationViewController *	self,
		const ViewController *	viewController
	)

Pops the top ViewController from the stack until the specified ViewController is visible.

Parameters

self	The NavigationViewController.
viewController	The ViewController to remain at the top of the stack.

Definition at line 80 of file NavigationViewController.c.

                                                                                                      {
 
  ViewController *topViewController;
  while ((topViewController = $(self, topViewController))) {
 
    if (topViewController == viewController) {
      break;
    }
 
    $(self, popViewController);
  }
}

popViewController()

void popViewController

(

NavigationViewController *

self

)

Pops the top ViewController from the stack.

Parameters

self	The NavigationViewController.

Definition at line 97 of file NavigationViewController.c.

                                                              {
 
  ViewController *topViewController = $(self, topViewController);
  if (topViewController) {
    $((ViewController *) self, removeChildViewController, topViewController);
  }
 
  ViewController *this = (ViewController *) self;
  ViewController *that = $(self, topViewController);
 
  if (that) {
    $(that, viewWillAppear);
    $(this->view, addSubview, that->view);
    $(that, viewDidAppear);
  }
}

pushViewController()

void pushViewController	(	NavigationViewController *	self,
		ViewController *	viewController
	)

Pushes the specified ViewController to the top of the stack.

Parameters

self	The NavigationViewController.
viewController	The ViewController.

Definition at line 47 of file NavigationViewController.c.

                                                                                               {
 
  assert(viewController);
 
  ViewController *this = (ViewController *) self;
 
  ViewController *topViewController = $(self, topViewController);
  if (topViewController) {
 
    $(topViewController, viewWillDisappear);
    $(this->view, removeSubview, topViewController->view);
    $(topViewController, viewDidDisappear);
  }
 
  $(this, addChildViewController, viewController);
}

rootViewController()

ViewController rootViewController

(

const NavigationViewController *

self

)

Parameters

self	The NavigationViewController.

Returns

The root ViewController on the stack.

Definition at line 118 of file NavigationViewController.c.

                                                                                {
  return (ViewController *) $((Array *) self->viewController.childViewControllers, firstObject);
}

topViewController()

ViewController topViewController

(

const NavigationViewController *

self

)

Parameters

self	The NavigationViewController.

Returns

The top ViewController on the stack.

Definition at line 126 of file NavigationViewController.c.

                                                                               {
  return (ViewController *) $((Array *) self->viewController.childViewControllers, lastObject);
}

Field Documentation

interface

NavigationViewControllerInterface* NavigationViewController::interface

protected

The interface.

Definition at line 54 of file NavigationViewController.h.

viewController

ViewController NavigationViewController::viewController

The superclass.

Definition at line 48 of file NavigationViewController.h.

---

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

• Sources/ObjectivelyMVC/NavigationViewController.h
• Sources/ObjectivelyMVC/NavigationViewController.c