Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
DocumentFile Class Reference

DocumentFile Api. More...

#include <androidcontentfileengine.h>

Inheritance diagram for DocumentFile:
Collaboration diagram for DocumentFile:

Public Member Functions

DocumentFilePtr createFile (const QString &mimeType, const QString &displayName)
DocumentFilePtr createDirectory (const QString &displayName)
const QJniObject & uri () const
const DocumentFilePtr & parent () const
QString initialName () const
QString name () const
QString id () const
QString mimeType () const
bool isDirectory () const
bool isFile () const
bool isVirtual () const
QDateTime lastModified () const
int64_t length () const
bool canRead () const
bool canWrite () const
bool remove ()
bool exists () const
std::vector< DocumentFilePtr > listFiles ()
bool rename (const QString &newName)

Static Public Member Functions

static DocumentFilePtr parseFromAnyUri (const QString &filename)
static DocumentFilePtr fromSingleUri (const QJniObject &uri)
static DocumentFilePtr fromTreeUri (const QJniObject &treeUri)
static QStringList getPathSegments (const QJniObject &uri)

Protected Member Functions

 DocumentFile (const QJniObject &uri, const QString &displayName, const std::shared_ptr< DocumentFile > &parent)

Protected Attributes

QString m_displayName
QJniObject m_uri
DocumentFilePtr m_parent

Detailed Description

DocumentFile Api.

Check https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile for more information.

Definition at line 76 of file androidcontentfileengine.h.

Constructor & Destructor Documentation

◆ DocumentFile()

DocumentFile::DocumentFile ( const QJniObject & uri,
const QString & displayName,
const std::shared_ptr< DocumentFile > & parent )
protected

Definition at line 611 of file androidcontentfileengine.cpp.

References DocumentFile().

Referenced by DocumentFile().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ canRead()

bool DocumentFile::canRead ( ) const

Definition at line 848 of file androidcontentfileengine.cpp.

◆ canWrite()

bool DocumentFile::canWrite ( ) const

Definition at line 860 of file androidcontentfileengine.cpp.

References DocumentsContract::Document::FLAG_DIR_SUPPORTS_CREATE, DocumentsContract::Document::FLAG_SUPPORTS_DELETE, and DocumentsContract::Document::FLAG_SUPPORTS_WRITE.

◆ createDirectory()

DocumentFilePtr DocumentFile::createDirectory ( const QString & displayName)

Definition at line 773 of file androidcontentfileengine.cpp.

References isDirectory().

Here is the call graph for this function:

◆ createFile()

DocumentFilePtr DocumentFile::createFile ( const QString & mimeType,
const QString & displayName )

Definition at line 762 of file androidcontentfileengine.cpp.

References isDirectory().

Here is the call graph for this function:

◆ exists()

bool DocumentFile::exists ( ) const

Definition at line 889 of file androidcontentfileengine.cpp.

◆ fromSingleUri()

DocumentFilePtr DocumentFile::fromSingleUri ( const QJniObject & uri)
static

Definition at line 735 of file androidcontentfileengine.cpp.

◆ fromTreeUri()

DocumentFilePtr DocumentFile::fromTreeUri ( const QJniObject & treeUri)
static

Definition at line 743 of file androidcontentfileengine.cpp.

◆ getPathSegments()

QStringList DocumentFile::getPathSegments ( const QJniObject & uri)
static

Definition at line 619 of file androidcontentfileengine.cpp.

◆ id()

QString DocumentFile::id ( ) const

Definition at line 803 of file androidcontentfileengine.cpp.

◆ initialName()

QString DocumentFile::initialName ( ) const

Definition at line 793 of file androidcontentfileengine.cpp.

◆ isDirectory()

bool DocumentFile::isDirectory ( ) const

Definition at line 813 of file androidcontentfileengine.cpp.

Referenced by createDirectory(), and createFile().

Here is the caller graph for this function:

◆ isFile()

bool DocumentFile::isFile ( ) const

Definition at line 818 of file androidcontentfileengine.cpp.

◆ isVirtual()

bool DocumentFile::isVirtual ( ) const

Definition at line 824 of file androidcontentfileengine.cpp.

◆ lastModified()

QDateTime DocumentFile::lastModified ( ) const

Definition at line 830 of file androidcontentfileengine.cpp.

◆ length()

int64_t DocumentFile::length ( ) const

Definition at line 838 of file androidcontentfileengine.cpp.

◆ listFiles()

std::vector< DocumentFilePtr > DocumentFile::listFiles ( )

Definition at line 894 of file androidcontentfileengine.cpp.

◆ mimeType()

QString DocumentFile::mimeType ( ) const

Definition at line 808 of file androidcontentfileengine.cpp.

◆ name()

QString DocumentFile::name ( ) const

Definition at line 798 of file androidcontentfileengine.cpp.

◆ parent()

const DocumentFilePtr & DocumentFile::parent ( ) const

Definition at line 788 of file androidcontentfileengine.cpp.

◆ parseFromAnyUri()

DocumentFilePtr DocumentFile::parseFromAnyUri ( const QString & filename)
static

Definition at line 643 of file androidcontentfileengine.cpp.

References documentSegment, and treeSegment.

◆ remove()

bool DocumentFile::remove ( )

Definition at line 884 of file androidcontentfileengine.cpp.

◆ rename()

bool DocumentFile::rename ( const QString & newName)

Definition at line 909 of file androidcontentfileengine.cpp.

References contentSchemeFull.

◆ uri()

const QJniObject & DocumentFile::uri ( ) const

Definition at line 783 of file androidcontentfileengine.cpp.

Member Data Documentation

◆ m_displayName

QString DocumentFile::m_displayName
protected

Definition at line 108 of file androidcontentfileengine.h.

◆ m_parent

DocumentFilePtr DocumentFile::m_parent
protected

Definition at line 110 of file androidcontentfileengine.h.

◆ m_uri

QJniObject DocumentFile::m_uri
protected

Definition at line 109 of file androidcontentfileengine.h.

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