Main Page | Class Hierarchy | Compound List | File List | Compound Members

MP7View Class Reference

This abstract class defines an interface of a view on an MPEG-7 document. More...

#include <MP7View.hpp>

Inherited by MP7VideoSegment.

List of all members.

Public Member Functions

virtual ~MP7View ()
 Destructor.

virtual bool isValid () const
 Return true if this view is valid, i.e.

virtual bool equals (const MP7View &view) const
 Return true if this view is equal to another view, i.e.

virtual void setMP7Doc (MP7Doc *doc)
 Specify the MP7Doc object this view is going to operate on.

MP7ListViewItemrootItem () const
 Return the root of this view.

virtual MP7ListViewItemparent (MP7ListViewItem *root=NULL) const
 Return the root of the parent view.

virtual MP7ListViewItemsetRoot (MP7ListViewItem *root, bool searchUp=false)=0
 Specify the root of this view, i.e.

virtual void setEmpty ()=0
 Create an empty XML element structure corresponding to this view.

virtual bool edit ()=0
 Show a modal top-level widget allowing the user to enter MPEG-7 data for all XML elements of this view.


Protected Member Functions

 MP7View ()
 Default constructor.


Protected Attributes

MP7Docdoc
 The MP7Doc object this view is going to operate on.

MP7ListViewItemroot
 The root of this view (see the class description).


Detailed Description

This abstract class defines an interface of a view on an MPEG-7 document.

We define a view as a subset of XML tree nodes of an MPEG-7 document. The root of a view is the root of the minimal XML subtree of the MPEG-7 document containing all the XML nodes of the view.

An implementation (subclass) of the view interface provides methods for easy creation and manipulation of a certain set of MPEG-7 descriptors within an MPEG-7 document. By defining creation and access methods in the view interface, an application could manage different views on the same MPEG-7 document in a generic manner. Moreover, the integration of additional views into the same application should become more feasible.

Author:
Mario Taschwer
Version:
Id
MP7View.hpp,v 1.5 2004/09/24 13:15:09 mtaschwer Exp


Member Function Documentation

virtual bool MP7View::edit  )  [pure virtual]
 

Show a modal top-level widget allowing the user to enter MPEG-7 data for all XML elements of this view.

Returns:
true if the MPEG-7 document has been successfully modified.

Implemented in MP7VideoSegment.

virtual bool MP7View::equals const MP7View view  )  const [inline, virtual]
 

Return true if this view is equal to another view, i.e.

if both views refer to the same MPEG-7 document and view root.

virtual bool MP7View::isValid  )  const [inline, virtual]
 

Return true if this view is valid, i.e.

if both the MPEG-7 document and the view root have been set.

virtual MP7ListViewItem* MP7View::parent MP7ListViewItem root = NULL  )  const [inline, virtual]
 

Return the root of the parent view.

Parameters:
root the root of the view whose parent should be determined; if NULL, this view's root will be used.
Returns:
NULL if there is no parent view.

Reimplemented in MP7VideoSegment.

virtual void MP7View::setEmpty  )  [pure virtual]
 

Create an empty XML element structure corresponding to this view.

Existing XML elements will not be deleted, but their values will be cleared. So calling this method twice should do no harm.

Implemented in MP7VideoSegment.

virtual MP7ListViewItem* MP7View::setRoot MP7ListViewItem root,
bool  searchUp = false
[pure virtual]
 

Specify the root of this view, i.e.

the root of the minimal XML subtree containing this view within the MPEG-7 document. If the given root element's tag name is not what this view expects it to be, the XML tree is searched for the nearest suitable element in the direction specified by the searchUp parameter.

Parameters:
root the root of this view, or an element in the vicinity of it.
searchUp if the tag name of root is not what this view expects it to be, the XML tree is searched along the path to the document root (searchUP == true), or in a breadth-first manner descending from root (searchUP == false), until the first suitable element is found. This element will become this view's root.
Returns:
the new root element, or NULL if no root element could be determined.

Implemented in MP7VideoSegment.


The documentation for this class was generated from the following file:
Generated on Mon Sep 27 09:12:05 2004 for Muvino by doxygen 1.3.2