StoryboardItem Class Reference

This class stores a list of StoryboardChild objects and provides functionality to manipulate the list. Specific item type must be stored at specific indices. More...

#include <StoryboardItem.h>

Inheritance diagram for StoryboardItem:

Public Types
enum	childType {   FrameNumber , ItemName , DurationSecond , DurationFrame ,   Comments }
	This enum defines the data type to be stored at particular indices. More...

Public Member Functions
void	appendChild (QVariant data)
QSharedPointer< StoryboardChild >	child (int row) const
int	childCount () const
void	cloneChildrenFrom (const StoryboardItem &other)
void	insertChild (int row, QVariant data=QVariant())
void	loadXML (const QDomElement &itemNode)
void	moveChild (int from, int to)
void	removeChild (int row)
	StoryboardItem ()
	StoryboardItem (const StoryboardItem &other)
QDomElement	toXML (QDomDocument doc)
	~StoryboardItem ()

Static Public Member Functions
static StoryboardItemList	cloneStoryboardItemList (const StoryboardItemList &list)

Private Attributes
QVector< QSharedPointer< StoryboardChild > >	m_childData

Detailed Description

This class stores a list of StoryboardChild objects and provides functionality to manipulate the list. Specific item type must be stored at specific indices.

Parameters

childType

enum for the indices and corresponding data type to be stored.

Definition at line 151 of file StoryboardItem.h.

Member Enumeration Documentation

childType

enum StoryboardItem::childType

This enum defines the data type to be stored at particular indices.

Parameters

FrameNumber	Store the frame number at index 0. Data type stored here should be ThumbnailData.
ItemName	Store the item name at index 1. Data type stored here should be string.
DurationSecond	Store the duration in second at index 2. Data type should be int.
DurationFrame	Store the duration in frame at index 3. Data type should be int.
Comments	Store the comments at indices greater_than_or_equal_to to index 4. Data type should be CommentBox.

Enumerator
FrameNumber	Store the frame number at index 0. Data type stored here should be ThumbnailData.
ItemName	Store the item name at index 1. Data type stored here should be string.
DurationSecond	Store the duration in second at index 2. Data type stored here should be int.
DurationFrame	Store the duration in frame at index 3. Data type stored here should be int.
Comments	Store the comments at indices greater_than_or_equal_to to index 4. Data type stored here should be CommentBox.

Definition at line 181 of file StoryboardItem.h.

                  {
 
        FrameNumber,
        ItemName,
        DurationSecond,
        DurationFrame,
        Comments
    };

Constructor & Destructor Documentation

StoryboardItem() [1/2]

StoryboardItem::StoryboardItem ( )

explicit

Definition at line 14 of file StoryboardItem.cpp.

    : m_childData()
{}

StoryboardItem() [2/2]

StoryboardItem::StoryboardItem

(

const StoryboardItem &

other

)

Definition at line 18 of file StoryboardItem.cpp.

    : QEnableSharedFromThis<StoryboardItem>()
    , m_childData()
{
    cloneChildrenFrom(other);
}

References cloneChildrenFrom().

~StoryboardItem()

StoryboardItem::~StoryboardItem

(

)

Definition at line 25 of file StoryboardItem.cpp.

{
    m_childData.clear();
}

References m_childData.

Member Function Documentation

appendChild()

void StoryboardItem::appendChild

(

QVariant

data

)

Definition at line 30 of file StoryboardItem.cpp.

{
    QSharedPointer<StoryboardChild> child = toQShared( new StoryboardChild(data) );
    child->setParent(sharedFromThis());
    m_childData.append(child);
}

References child(), m_childData, and toQShared().

child()

QSharedPointer< StoryboardChild > StoryboardItem::child

(

int

row

)

const

Definition at line 69 of file StoryboardItem.cpp.

{
    if (row < 0 || row >= m_childData.size()) {
        return nullptr;
    }
    return m_childData.at(row);
}

References m_childData.

childCount()

int StoryboardItem::childCount

(

)

const

Definition at line 64 of file StoryboardItem.cpp.

{
    return m_childData.count();
}

References m_childData.

cloneChildrenFrom()

void StoryboardItem::cloneChildrenFrom

(

const StoryboardItem &

other

)

Definition at line 37 of file StoryboardItem.cpp.

{
    m_childData.clear();
    for (int i = 0; i < other.m_childData.count(); i++) {
        QSharedPointer<StoryboardChild> child = toQShared( new StoryboardChild(*other.m_childData.at(i)));
        child->setParent(sharedFromThis());
        m_childData.append(child);
    }
}

References child(), m_childData, and toQShared().

cloneStoryboardItemList()

StoryboardItemList StoryboardItem::cloneStoryboardItemList ( const StoryboardItemList & list )

static

Definition at line 123 of file StoryboardItem.cpp.

{
    StoryboardItemList clonedList;
    for (auto i = 0; i < list.count(); i++) {
        StoryboardItemSP item = toQShared( new StoryboardItem(*list.at(i)) );
        item->cloneChildrenFrom(*list.at(i));
        clonedList.append(item);
    }
    return clonedList;
}

References StoryboardItem(), and toQShared().

insertChild()

void StoryboardItem::insertChild	(	int	row,
		QVariant	data = QVariant() )

Definition at line 47 of file StoryboardItem.cpp.

{
    QSharedPointer<StoryboardChild> child = toQShared( new StoryboardChild(data) );
    child->setParent(sharedFromThis());
    m_childData.insert(row, child);
}

References child(), m_childData, and toQShared().

loadXML()

void StoryboardItem::loadXML

(

const QDomElement &

itemNode

)

Definition at line 100 of file StoryboardItem.cpp.

{
    ThumbnailData thumbnail;
    thumbnail.frameNum = itemNode.attribute("frame").toInt();
    appendChild(QVariant::fromValue<ThumbnailData>(thumbnail));
    appendChild(itemNode.attribute("item-name"));
    appendChild(itemNode.attribute("duration-second").toInt());
    appendChild(itemNode.attribute("duration-frame").toInt());
 
    for (QDomElement commentNode = itemNode.firstChildElement(); !commentNode.isNull(); commentNode = commentNode.nextSiblingElement()) {
        if (commentNode.nodeName().toUpper() != "COMMENT") continue;
 
        CommentBox comment;
        if (commentNode.hasAttribute("content")) {
            comment.content = commentNode.attribute("content");
        }
        if (commentNode.hasAttribute("scroll-value")) {
            comment.scrollValue = commentNode.attribute("scroll-value");
        }
        appendChild(QVariant::fromValue<CommentBox>(comment));
    }
}

References appendChild(), CommentBox::content, ThumbnailData::frameNum, and CommentBox::scrollValue.

moveChild()

void StoryboardItem::moveChild	(	int	from,
		int	to )

Definition at line 59 of file StoryboardItem.cpp.

{
    m_childData.move(from, to);
}

References m_childData.

removeChild()

void StoryboardItem::removeChild

(

int

row

)

Definition at line 54 of file StoryboardItem.cpp.

{
    m_childData.removeAt(row);
}

References m_childData.

toXML()

QDomElement StoryboardItem::toXML

(

QDomDocument

doc

)

Definition at line 77 of file StoryboardItem.cpp.

{
    QDomElement itemElement = doc.createElement("storyboarditem");
 
    int frame = qvariant_cast<ThumbnailData>(child(FrameNumber)->data()).frameNum.toInt();
    itemElement.setAttribute("frame", frame);
    itemElement.setAttribute("item-name", child(ItemName)->data().toString());
    itemElement.setAttribute("duration-second", child(DurationSecond)->data().toInt());
    itemElement.setAttribute("duration-frame", child(DurationFrame)->data().toInt());
 
    for (int i = Comments; i < childCount(); i++) {
        CommentBox comment = qvariant_cast<CommentBox>(child(i)->data());
        QDomElement commentElement = doc.createElement("comment");
 
        commentElement.setAttribute("content", comment.content.toString());
        commentElement.setAttribute("scroll-value", comment.scrollValue.toInt());
 
        itemElement.appendChild(commentElement);
    }
 
    return itemElement;
}

References child(), childCount(), Comments, CommentBox::content, DurationFrame, DurationSecond, FrameNumber, ItemName, and CommentBox::scrollValue.

Member Data Documentation

m_childData

QVector<QSharedPointer<StoryboardChild> > StoryboardItem::m_childData

private

Definition at line 206 of file StoryboardItem.h.

---

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

• libs/ui/StoryboardItem.h
• libs/ui/StoryboardItem.cpp