Anklang-0.3.0-1416-gfa8ce8d2 anklang-0.3.0-1416-gfa8ce8d2
ASE — Anklang Sound Engine (C++)

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
Ase::ResourceCrawler Class Referenceabstract

Helper to crawl hierarchical resources. More...

#include "api.hh"

Inheritance diagram for Ase::ResourceCrawler:
[legend]

Public Types

using String2 = std::pair< String, String >
 

Public Member Functions

virtual Resource folder () const =0
 Describe current folder.
 
virtual void folder (const Resource &newfolder)=0
 
virtual ResourceS entries () const =0
 List entries of a folder.
 
virtual void entries (const ResourceS &newentries)=0
 
virtual String2 assign (const String &utf8path, bool existingfile=false)=0
 Move to a different path.
 
virtual Resource canonify (const String &utf8cwd, const String &utf8fragment, bool constraindir, bool constrainfile)=0
 Return absolute path, slash-terminated if directory, constrain to existing paths.
 
- Public Member Functions inherited from Ase::Emittable
virtual void emit_event (const String &type, const String &detail, const ValueR fields={})=0
 
virtual void emit_notify (const String &detail)=0
 
void js_trigger (const String &eventselector, JsTrigger callback)
 
- Public Member Functions inherited from std::enable_shared_from_this< SharedBase >
T enable_shared_from_this (T... args)
 
T operator= (T... args)
 
T shared_from_this (T... args)
 
T weak_from_this (T... args)
 
T ~enable_shared_from_this (T... args)
 

Additional Inherited Members

- Public Attributes inherited from Ase::Emittable
const EventHandler & eventhandler
 

Detailed Description

Helper to crawl hierarchical resources.

Definition at line 376 of file api.hh.

Member Typedef Documentation

◆ String2

Definition at line 384 of file api.hh.

Constructor & Destructor Documentation

◆ ResourceCrawler()

Ase::ResourceCrawler::ResourceCrawler ( )
explicitprotected

Definition at line 22 of file crawler.cc.

Member Function Documentation

◆ assign()

virtual String2 Ase::ResourceCrawler::assign ( const String &  utf8path,
bool  existingfile = false 
)
pure virtual

Move to a different path.

Implemented in Ase::FileCrawler.

◆ canonify()

virtual Resource Ase::ResourceCrawler::canonify ( const String &  utf8cwd,
const String &  utf8fragment,
bool  constraindir,
bool  constrainfile 
)
pure virtual

Return absolute path, slash-terminated if directory, constrain to existing paths.

Implemented in Ase::FileCrawler.

◆ entries()

virtual ResourceS Ase::ResourceCrawler::entries ( ) const
pure virtual

List entries of a folder.

Implemented in Ase::FileCrawler.

◆ folder()

virtual Resource Ase::ResourceCrawler::folder ( ) const
pure virtual

Describe current folder.

Implemented in Ase::FileCrawler.


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