HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CH_Bookmark Class Reference

#include <CH_Bookmark.h>

Public Member Functions

 CH_Bookmark (const UT_StringHolder &name, fpreal start, fpreal end, const UT_Color &color, bool temporary=false)
 
 ~CH_Bookmark ()
 
 CH_Bookmark (const CH_Bookmark &other)
 
 CH_Bookmark (CH_Bookmark &&other)=default
 
CH_Bookmarkoperator= (const CH_Bookmark &other)
 
CH_Bookmarkoperator= (CH_Bookmark &&other)=default
 
const UT_StringHoldergetName () const
 
void setName (const UT_StringHolder &name)
 
const UT_StringHoldergetComment () const
 
void setComment (const UT_StringHolder &comment)
 
fpreal getStartTime () const
 
void setStartTime (fpreal t)
 
fpreal getEndTime () const
 
void setEndTime (fpreal t)
 
int getIndex () const
 
UT_Color getColor () const
 
void setColor (const UT_Color &color)
 
bool isVisible () const
 
void setVisible (bool visible)
 
int64 sessionId () const
 
void setTemporary (bool temporary)
 
bool isTemporary () const
 
void enable ()
 
void disable ()
 
bool isEnabled () const
 
bool save (UT_JSONWriter &w) const
 
bool load (UT_JSONParser &p)
 
bool loadOTIOFormat (UT_JSONParser &p)
 
UT_OptionsgetMetadata ()
 
void setMetadata (const UT_Options &options)
 
void updateMetadata (const UT_Options &other)
 

Detailed Description

Definition at line 22 of file CH_Bookmark.h.

Constructor & Destructor Documentation

CH_Bookmark::CH_Bookmark ( const UT_StringHolder name,
fpreal  start,
fpreal  end,
const UT_Color color,
bool  temporary = false 
)
CH_Bookmark::~CH_Bookmark ( )
CH_Bookmark::CH_Bookmark ( const CH_Bookmark other)
CH_Bookmark::CH_Bookmark ( CH_Bookmark &&  other)
default

Member Function Documentation

void CH_Bookmark::disable ( )
inline

Definition at line 61 of file CH_Bookmark.h.

void CH_Bookmark::enable ( )
inline

Definition at line 60 of file CH_Bookmark.h.

UT_Color CH_Bookmark::getColor ( ) const
inline

Definition at line 49 of file CH_Bookmark.h.

const UT_StringHolder& CH_Bookmark::getComment ( ) const
inline

Definition at line 40 of file CH_Bookmark.h.

fpreal CH_Bookmark::getEndTime ( ) const
inline

Definition at line 45 of file CH_Bookmark.h.

int CH_Bookmark::getIndex ( ) const
UT_Options& CH_Bookmark::getMetadata ( )
inline

Definition at line 69 of file CH_Bookmark.h.

const UT_StringHolder& CH_Bookmark::getName ( ) const
inline

Definition at line 37 of file CH_Bookmark.h.

fpreal CH_Bookmark::getStartTime ( ) const
inline

Definition at line 43 of file CH_Bookmark.h.

bool CH_Bookmark::isEnabled ( ) const
inline

Definition at line 63 of file CH_Bookmark.h.

bool CH_Bookmark::isTemporary ( ) const
inline

Definition at line 58 of file CH_Bookmark.h.

bool CH_Bookmark::isVisible ( ) const
inline

Definition at line 52 of file CH_Bookmark.h.

bool CH_Bookmark::load ( UT_JSONParser p)
bool CH_Bookmark::loadOTIOFormat ( UT_JSONParser p)
CH_Bookmark& CH_Bookmark::operator= ( const CH_Bookmark other)
CH_Bookmark& CH_Bookmark::operator= ( CH_Bookmark &&  other)
default
bool CH_Bookmark::save ( UT_JSONWriter w) const
int64 CH_Bookmark::sessionId ( ) const
inline

Definition at line 55 of file CH_Bookmark.h.

void CH_Bookmark::setColor ( const UT_Color color)
inline

Definition at line 50 of file CH_Bookmark.h.

void CH_Bookmark::setComment ( const UT_StringHolder comment)
inline

Definition at line 41 of file CH_Bookmark.h.

void CH_Bookmark::setEndTime ( fpreal  t)
inline

Definition at line 46 of file CH_Bookmark.h.

void CH_Bookmark::setMetadata ( const UT_Options options)
inline

Definition at line 70 of file CH_Bookmark.h.

void CH_Bookmark::setName ( const UT_StringHolder name)
inline

Definition at line 38 of file CH_Bookmark.h.

void CH_Bookmark::setStartTime ( fpreal  t)
inline

Definition at line 44 of file CH_Bookmark.h.

void CH_Bookmark::setTemporary ( bool  temporary)
inline

Definition at line 57 of file CH_Bookmark.h.

void CH_Bookmark::setVisible ( bool  visible)
inline

Definition at line 53 of file CH_Bookmark.h.

void CH_Bookmark::updateMetadata ( const UT_Options other)
inline

Definition at line 71 of file CH_Bookmark.h.


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