Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

PIAVE::StoryElement Class Reference

The StoryElement is the abstract base class for all objects that can be element of a StoryBoard. More...

#include <storybase.hh>

Inheritance diagram for PIAVE::StoryElement:

PIAVE::MediaElement PIAVE::AVChunk PIAVE::ColorStill PIAVE::StoryBNode PIAVE::StoryBoard PIAVE::StorySeqNode PIAVE::StoryUNode PIAVE::BinaryOp PIAVE::UnaryOp List of all members.

Public Methods

 StoryElement (const std::string &name=std::string(), Time start=0, Time length=0)
 default constructor, all params have default values

virtual ~StoryElement ()
 does nothing yet

const std::string & name () const
 get name

const std::string & setName (const std::string &name)
 set name

const std::string & comment () const
 get comment

const std::string & setComment (const std::string &comment)
 set comment

virtual int fixMe (int fix_lvl=0)
 check subtree for internal inconsistencies and fix according to fix_lvl


Private Attributes

std::string _name
 the _name is supposed to be a short std::string describing the element

std::string _comment
 the _comment can hold a more detailed description / text


Detailed Description

The StoryElement is the abstract base class for all objects that can be element of a StoryBoard.


Member Function Documentation

virtual int PIAVE::StoryElement::fixMe int    fix_lvl = 0 [inline, virtual]
 

check subtree for internal inconsistencies and fix according to fix_lvl

Parameters:
fix_lvl  * - 0 : don't fix, just warn
  • >0 : fix not so serious problems allowed to happen during editing
  • >10 : fix serious problems should never happen, bug if otherwise ! might leak memory or corrupt track !
Returns:
number of unfixed internal inconsistencies

Reimplemented in PIAVE::AVChunk, PIAVE::NullUOp, PIAVE::NullBOp, PIAVE::CopyAOp, PIAVE::ReplaceAudioOp, PIAVE::StoryBNode, PIAVE::StoryUNode, PIAVE::StorySeqNode, PIAVE::StoryBoard, and PIAVE::OverlayOp.


The documentation for this class was generated from the following files:
Generated on Tue Oct 14 20:45:37 2003 for piave by doxygen1.2.18