Ocean::Interaction::UserInterface Class Reference

This class holds UI elements of the application from which the interaction is executed. More...

Public Member Functions
	UserInterface ()=default
	Default constructor. More...
	UserInterface (UIWindow *window, UIViewController *viewController)
	Creates new user interface object for iOS applications. More...
UIWindow *	window () const
	Returns the window of the application. More...
UIViewController *	viewController () const
	Returns the view controller of the iOS application. More...
bool	isIOS () const
	Returns whether this object holds UI elements for an iOS application. More...

Protected Attributes
bool	isIOS_ = false
	True, in case this object holds UI elements for an iOS application. More...
UIWindow *	window_ = nullptr
	The application's window; nullptr if not an iOS application. More...
UIViewController *	viewController_ = nullptr
	The application's view controller; nullptr if not an iOS application. More...

Detailed Description

This class holds UI elements of the application from which the interaction is executed.

Constructor & Destructor Documentation

UserInterface() [1/2]

Ocean::Interaction::UserInterface::UserInterface ( )

default

Default constructor.

UserInterface() [2/2]

Ocean::Interaction::UserInterface::UserInterface	(	UIWindow *	window,
		UIViewController *	viewController
	)

Creates new user interface object for iOS applications.

Parameters

window	The application's window, must be valid
viewController	The application's view controller, must be valid

Member Function Documentation

isIOS()

bool Ocean::Interaction::UserInterface::isIOS ( ) const

inline

Returns whether this object holds UI elements for an iOS application.

Returns

True, if so

viewController()

UIViewController* Ocean::Interaction::UserInterface::viewController

(

)

const

Returns the view controller of the iOS application.

Returns

The application's view controller; nullptr if not an iOS application

window()

UIWindow* Ocean::Interaction::UserInterface::window

(

)

const

Returns the window of the application.

Returns

The application's window; nullptr if not an iOS application

Field Documentation

isIOS_

bool Ocean::Interaction::UserInterface::isIOS_ = false

protected

True, in case this object holds UI elements for an iOS application.

viewController_

UIViewController* Ocean::Interaction::UserInterface::viewController_ = nullptr

protected

The application's view controller; nullptr if not an iOS application.

window_

UIWindow* Ocean::Interaction::UserInterface::window_ = nullptr

protected

The application's window; nullptr if not an iOS application.

---

The documentation for this class was generated from the following file:

• UserInterface.h