OpenShot Video Editor  2.0.0
Public Member Functions | Static Public Attributes | List of all members
query.File Class Reference

This class allows Files to be queried, updated, and deleted from the project data. More...

Inheritance diagram for query.File:
query.QueryObject

Public Member Functions

def absolute_path (self)
 Get absolute file path of file. More...
 
def delete (self)
 Delete the object from the project data store. More...
 
def filter (kwargs)
 Take any arguments given as filters, and find a list of matching objects. More...
 
def get (kwargs)
 Take any arguments given as filters, and find the first matching object. More...
 
def relative_path (self)
 Get relative path (based on the current working directory) More...
 
def save (self)
 Save the object back to the project data store. More...
 
- Public Member Functions inherited from query.QueryObject
def __init__ (self)
 Constructor. More...
 
def delete (self, OBJECT_TYPE)
 Delete the object from the project data store. More...
 
def filter (OBJECT_TYPE, kwargs)
 Take any arguments given as filters, and find a list of matching objects. More...
 
def get (OBJECT_TYPE, kwargs)
 Take any arguments given as filters, and find the first matching object. More...
 
def save (self, OBJECT_TYPE)
 Save the object back to the project data store. More...
 
def title (self)
 Get the translated display title of this item. More...
 

Static Public Attributes

list object_key = [object_name]
 
string object_name = "files"
 

Additional Inherited Members

- Public Attributes inherited from query.QueryObject
 data
 
 id
 
 key
 
 parent
 
 type
 

Detailed Description

This class allows Files to be queried, updated, and deleted from the project data.

Definition at line 236 of file query.py.

Member Function Documentation

◆ absolute_path()

def query.File.absolute_path (   self)

Get absolute file path of file.

Definition at line 262 of file query.py.

◆ delete()

def query.File.delete (   self)

Delete the object from the project data store.

Definition at line 247 of file query.py.

◆ filter()

def query.File.filter (   kwargs)

Take any arguments given as filters, and find a list of matching objects.

Definition at line 252 of file query.py.

◆ get()

def query.File.get (   kwargs)

Take any arguments given as filters, and find the first matching object.

Definition at line 257 of file query.py.

◆ relative_path()

def query.File.relative_path (   self)

Get relative path (based on the current working directory)

Definition at line 279 of file query.py.

◆ save()

def query.File.save (   self)

Save the object back to the project data store.

Definition at line 242 of file query.py.

Member Data Documentation

◆ object_key

list query.File.object_key = [object_name]
static

Definition at line 238 of file query.py.

◆ object_name

string query.File.object_name = "files"
static

Definition at line 237 of file query.py.


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