ZFFramework
 
Loading...
Searching...
No Matches
ZFPInterface_ZFRes Class Reference

protocol for ZFFile More...

#include <ZFProtocolZFRes.h>

Inheritance diagram for ZFPInterface_ZFRes:
ZFProtocol

Public Member Functions

virtual const zfcharprotocolName (void) const
 get the name of the protocol module, e.g. "ZFObject"
 
virtual const zfstringresRootPath (void)
 util method to access root path for file res impl
 
virtual zfbool resIsExist (const zfchar *resPath)
 see ZFResIsExist
 
virtual zfbool resIsDir (const zfchar *resPath)
 see ZFResIsDir
 
virtual zfbool resCopy (const zfchar *resPath, const zfchar *dstPath, zfbool isRecursive=_ZFT_t_zftrue, zfbool isForce=_ZFT_t_zftrue)
 see ZFResCopy
 
virtual void * resOpen (const zfchar *resPath)
 see ZFResOpen
 
virtual zfbool resClose (void *token)
 see ZFResClose
 
virtual zfindex resTell (void *token)
 see ZFResTell
 
virtual zfbool resSeek (void *token, zfindex byteSize, ZFSeekPos position=ZFSeekPosBegin)
 see ZFResSeek
 
virtual zfindex resRead (void *token, void *buf, zfindex maxByteSize)
 see ZFResRead
 
virtual zfbool resIsEof (void *token)
 see ZFResIsEof
 
virtual zfbool resIsError (void *token)
 see ZFResIsError
 
virtual zfbool resFindFirst (ZFFileFindData::Impl &fd, const zfchar *resPath)
 see ZFResFindFirst, ZFFileFindFirst
 
virtual zfbool resFindNext (ZFFileFindData::Impl &fd)
 see ZFResFindNext, ZFFileFindNext
 
virtual void resFindClose (ZFFileFindData::Impl &fd)
 see ZFResFindClose, ZFFileFindClose
 
- 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 zfcharprotocolImplName (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 zfcharprotocolImplPlatformHint (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_ZFRes zfself
 class ref to self
 

Detailed Description

protocol for ZFFile

Member Function Documentation

◆ protocolName()

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

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

Reimplemented from ZFProtocol.

◆ resRootPath()

virtual const zfstring & ZFPInterface_ZFRes::resRootPath ( void )
virtual

util method to access root path for file res impl

for most file res impl, res processing is the same as normal file processing, except the root path differs, so we supply an default impl that process like normal files, and let different impl to specify different root path
by default, this method would return "./zfres/"


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