Objective-C API Library Reference  4.3.0-42-g45f162a
 All Classes Functions Typedefs Properties Pages
Public Types | Public Functions | Public Static Functions | Properties | List of all members
PWFrameworkSingleton Class Reference

The PWFrameworkSingleton class is the default instance of the framework.

Deprecated

(5.0) - PW_DEPRECATED_SELECTOR
 

Public Types

typedef PWViewRenderer *(^ PWViewRendererBlock )(CALayer *)
 

Public Functions

(PWWebClient *) - client
 
(PWCollaborationManager *) - collaborationManager
 
(id< PWCommandFilterProtocol >) - commandFilter
 
(void) - CommandFilter:
 
(PWViewRenderer *) - createViewRenderer:view:
 
(id< PWFrameworkDelegate >) - delegate
 
(void) - disableExternalDisplay
 
(void) - enableExternalDisplay
 
(BOOL) - hasViewRenderer:
 
(BOOL) - isStateInitialized
 
(PWEventPublisher *) - isStateInitializedChanged
 
(void) - registerViewRenderer:block:
 
(void) - registerViewRenderer:target:selector:
 
(NSString *) - sessionId
 
(PWEventPublisher *) - sessionIdChanged
 
(void) - setDelegate:
 
(PWApplicationState *) - state
 

Public Static Functions

(PWFrameworkSingleton *) + sharedInstance
 

Properties

PWGuidguid
 
PWProfilerManagerprofiler
 

Member Typedef Documentation

- (typedef PWViewRenderer*(^ PWViewRendererBlock)(CALayer *))
inherited

Block helper

Methods Descriptions

- (PWWebClient *) client

Returns the PWWebClient instance.

- (PWCollaborationManager *) collaborationManager

Returns the PWCollaborationManager instance.

- (id <PWCommandFilterProtocol>) commandFilter

Returns the object currently set as the PWCommandFilterProtocol selector.

- (void) CommandFilter: (id< PWCommandFilterProtocol >)  commandFilter

Sets the PWCommandFilterProtocol selector.

- (PWViewRenderer *) createViewRenderer: (NSString *)  mimeType
view: (CALayer *)  view 

Generates a new PWViewRenderer instance based on the registered factories.

Parameters
mimeTypeThe mime type used to transmit image data. Setting the view renderer of an existing mime type will replace that renderer.
viewThe target view for the rendering.
- (id<PWFrameworkDelegate>) delegate

Returns the PWFrameworkDelegate instance.

- (void) disableExternalDisplay

Disables the external display.

- (void) enableExternalDisplay

Enables the external display.

- (BOOL) hasViewRenderer: (NSString *)  mimeType

Queries the framework to determine if it has a renderer registered for this mime type.

Parameters
mimeTypeThe mime type used to transmit image data. Setting the view renderer of an existing mime type will replace that renderer.
- (BOOL) isStateInitialized

Returns a Boolean value that indicates whether application state has been initialized.

- (PWEventPublisher *) isStateInitializedChanged

The event that gets dispatched when the state is initialized or uninitialized.

- (5.0) PW_DEPRECATED_SELECTOR
Note
This stateInitialized method is deprecated. Please use the isStateInitializedChanged event and the isStateInitialized property.

The event that gets dispatched when the state is initialized or uninitialized.

- (void) registerViewRenderer: (NSString *)  mimeType
block: (PWViewRendererBlock block 

Registers a new view renderer. A view renderer takes binary input data representing the content of the view and renders it to the view. Custom renderers can be added to the view class to support extension of PureWeb to currently unsupported codecs, or to replace existing render paths with custom alternatives.

Parameters
mimeTypeThe mime type used to transmit image data. Setting the view renderer of an existing mime type will replace that renderer.
blockThe factory method that generates a new PWViewRenderer.
- (void) registerViewRenderer: (NSString *)  mimeType
target: (id)  target
selector: (SEL)  selector 

Registers a new view renderer.

A view renderer takes binary input data representing the content of the view and renders it to the view. Custom renderers can be added to the PWView class to support extension of PureWeb to currently unsupported codecs, or to replace existing render paths with custom alternatives.

Parameters
mimeTypeThe mime type used to transmit image data. Setting the view renderer of an existing mime type will replace that renderer.
targetThe target object.
selectorThe factory method that generates a new PWViewRenderer.
- (NSString *) sessionId

Returns the session's unique identifier.

- (PWEventPublisher *) sessionIdChanged

The event that gets dispatched when the session's unique identifier is set or changed.

- (void) setDelegate: (id< PWFrameworkDelegate >)  delegate

Sets the PWFrameworkDelegate instance.

+ (PWFrameworkSingleton *) sharedInstance

Returns a static PWFrameworkSingleton instance.

Implements PWFramework.

- (PWApplicationState *) state

Returns the PWApplicationState instance.

Properties Descriptions

- (PWGuid*) guid
readnonatomicstronginherited

The unique identifier of this framework instance.

- (PWProfilerManager*) profiler
readnonatomicstronginherited

The instance of the PWProfilerManager for this framework instance.