ZFFramework
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | List of all members
ZFPInterface_ZFUIRootWindow Class Referenceabstract

protocol for ZFUIRootWindow More...

#include <ZFProtocolZFUIRootWindow.h>

Inheritance diagram for ZFPInterface_ZFUIRootWindow:
ZFProtocol

Public Member Functions

virtual const zfchar * protocolName (void) const
 get the name of the protocol module, e.g. "ZFObject"
 
virtual ZFUIRootWindow * mainWindow (void)=0
 see ZFUIRootWindow::mainWindow
 
virtual void mainWindowOnCleanup (void)=0
 called to cleanup native main window
 
virtual void mainWindowOnDestroy (void)=0
 called when main window destroyed by notifyOnDestroy
 
virtual void nativeWindowOnCleanup (ZFUIRootWindow *rootWindow)
 called when owner ZFUIRootWindow is about to destroy
 
virtual void nativeWindowRootViewOnAdd (ZFUIRootWindow *rootWindow, void *&nativeParentView)=0
 called to add root view to native window container
 
virtual void nativeWindowRootViewOnRemove (ZFUIRootWindow *rootWindow)=0
 called to remove root view to native window container
 
virtual zfauto modalWindowShow (ZFUIRootWindow *owner)=0
 see ZFUIRootWindow::modalWindowShow
 
virtual void modalWindowHide (ZFUIRootWindow *owner, ZFUIRootWindow *toHide)=0
 see ZFUIRootWindow::modalWindowHide
 
virtual void layoutParamOnInit (ZFUIRootWindow *rootWindow)
 called to update suggested window layout param, fill with no margin by default
 
virtual void layoutParamOnUpdate (ZFUIRootWindow *rootWindow)
 called when window layout param changed
 
virtual ZFUIOrientation windowOrientation (ZFUIRootWindow *rootWindow)=0
 see ZFUIRootWindow::windowOrientation
 
virtual void windowOrientationFlags (ZFUIRootWindow *rootWindow, const ZFUIOrientationFlags &flags)=0
 see ZFUIRootWindow::windowOrientationFlags, impl should have v_ZFUIOrientation::e_Top as init value
 
ZFUIRect notifyMeasureWindow (ZFUIRootWindow *rootWindow, const ZFUIRect &rootRefRect, const ZFUIMargin &windowMargin)
 implementation must call this method to measure window's frame, and layout window using the result frame
 
void notifyOnCreate (ZFUIRootWindow *rootWindow, void *nativeWindow)
 implementation must call this to notify after window create
 
void notifyOnDestroy (ZFUIRootWindow *rootWindow)
 implementation must call this to notify before window destroy
 
void notifyOnResume (ZFUIRootWindow *rootWindow)
 implementation must call this to notify after window resume, note that rotate a window should not notify this
 
void notifyOnPause (ZFUIRootWindow *rootWindow)
 implementation must call this to notify before window pause, note that rotate a window should not notify this
 
void notifyOnRotate (ZFUIRootWindow *rootWindow)
 implementation must call this to notify when window rotate
 
void notifyKeyEvent (ZFUIRootWindow *rootWindow, ZFUIKeyEvent *event)
 implementation must call this to notify key event
 
- Public Member Functions inherited from ZFProtocol
virtual void protocolOnInit (void)
 called to init the protocol
 
virtual void protocolOnInitFinish (void)
 see protocolOnInit
 
virtual void protocolOnDeallocPrepare (void)
 see protocolOnInit
 
virtual void protocolOnDealloc (void)
 see protocolOnInit
 
virtual ZFProtocolInstanceState protocolInstanceState (void)
 protocol instance's state
 
virtual const zfchar * protocolImplName (void) const
 get the name of the protocol implementation, e.g. "ZFObject_default"
 
virtual ZFProtocolLevel protocolImplLevel (void) const
 get the level of the protocol implementation
 
virtual const zfchar * protocolImplPlatformHint (void) const
 get type hint of the implementation or empty string if not defined, e.g. "iOS:NSString" for iOS's string impl, use ZFPROTOCOL_IMPLEMENTATION_PLATFORM_HINT to register
 
virtual void objectInfoT (zfstring &ret) const
 see objectInfo
 
virtual zfstring objectInfo (void) const
 get a short info about this object
 

Protected Types

typedef ZFProtocol zfsuper
 class ref to super
 
typedef ZFPInterface_ZFUIRootWindow zfself
 class ref to self
 

Detailed Description

protocol for ZFUIRootWindow

Member Function Documentation

◆ protocolName()

virtual const zfchar * ZFPInterface_ZFUIRootWindow::protocolName ( void ) const
inlinevirtual

get the name of the protocol module, e.g. "ZFObject"

Reimplemented from ZFProtocol.

◆ mainWindow()

virtual ZFUIRootWindow * ZFPInterface_ZFUIRootWindow::mainWindow ( void )
pure virtual

see ZFUIRootWindow::mainWindow

for implementations, you should create a new window if not initialized, or return the created one if exist

◆ mainWindowOnCleanup()

virtual void ZFPInterface_ZFUIRootWindow::mainWindowOnCleanup ( void )
pure virtual

called to cleanup native main window

this is ensured to be called during ZFFrameworkCleanup with level ZFLevelZFFrameworkLow
after cleanup, you must ensured it's reentrant to access the main window again

◆ nativeWindowRootViewOnAdd()

virtual void ZFPInterface_ZFUIRootWindow::nativeWindowRootViewOnAdd ( ZFUIRootWindow * rootWindow,
void *& nativeParentView )
pure virtual

called to add root view to native window container

if nativeParentView was specified, it would be used to copy some settings to the window's root view

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