Timeline Class Reference

#include <Timeline.h>

Inherits QGraphicsView.

Public Slots
int	getBookmarkHeight () const
void	setBookmarkHeight (int height)
int	getMarginTopBot ()
void	setMarginTopBot (int margin)
int	getMarginLR ()
void	setMarginLR (int margin)
const QColor &	getBackgroundColor () const
void	setBackgroundColor (const QColor &color)
int	getWidth ()
void	setWidth (int width)
int	getMinIndex ()
void	setMinIndex (int minIndex)
int	getSteps ()
void	setSteps (int steps)
int	getStepSize ()
void	setStepSize (int stepSize)
int	getMaxIndex ()
int	getSliderIndex ()
int	getStartMarkerIndex ()
void	setStartMarkerIndex (int idx)
int	getEndMarkerIndex ()
void	setEndMarkerIndex (int idx)
void	setSliderIndex (int idx)
void	addBookmark (int idx)
void	addBookmarks (QVector< int > bookmarks)
void	removeBookmark (int idx)
void	removeAllBookmarks ()
bool	hasBookmarkAtIndex (int idx)

Signals
void	indexSliderClicked ()
void	endMarkerClicked ()
void	startMarkerClicked ()
void	indexSliderReleased (int idx)
void	startMarkerMoved (int idx)
void	endMarkerMoved (int idx)
void	indexSliderMoved (int idx)
void	startMarkerReleased (int idx)
void	endMarkerReleased (int idx)
void	bookmarkClicked (int idx)
void	bookmarkRemoved (int idx)
void	timeout ()

Public Member Functions
	Timeline (QWidget *parent=0)

Protected Member Functions
void	resizeEvent (QResizeEvent *event)

Properties
int	bookmark_height
int	margin_topbot
int	margin_lr
QColor	backgroundColor
int	width
unsigned minIndex	READ
unsigned steps	READ
unsigned stepSize	READ

Detailed Description

This widget provides an improved Slider. Besides the standard slider functionality you can mark a region on the slide bar to select a certain interval between two indices. There are two markers: the start marker (left) and the end marker (right). The thin vertical slider is the index slider which is the pendant to the standard slider.

Author

Allan E. Conquest - allan.nosp@m..con.nosp@m.quest.nosp@m.@dfk.nosp@m.i.de

Definition at line 25 of file Timeline.h.

Constructor & Destructor Documentation

Timeline::Timeline

(

QWidget *

parent = 0

)

Definition at line 9 of file Timeline.cc.

                                  {
    setParent(parent);
    
    // Default property values
    bookmarkHeight = 6;
    marginTopBot = 5;
    marginLR = 5;
    bgColor = QColor(Qt::white);
    ordered_width = 400;
    minIndex = 0;
    steps = 10;
    stepSize = 1;
    
    reconfigure_slidebar = false;
    
    setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
    setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
    
    // Setup scene
    scene = new QGraphicsScene;
    scene->setBackgroundBrush(getBackgroundColor());
    setAlignment(Qt::AlignLeft | Qt::AlignTop);
    setScene(scene);
    setRenderHint(QPainter::Antialiasing);
    setViewportUpdateMode(QGraphicsView::FullViewportUpdate);

    // Add items
    slidebar = new SlideBarItem(getMinIndex(), getSteps(), getStepSize());
    slidebar->setBookmarkHeight(getBookmarkHeight());
    slidebar->setWidth(ordered_width - getMarginLR()*2);
    slidebar->setHeight(ordered_width - height());
    
    scene->addItem(slidebar);
    
    startmarker = new BoundarySlider(slidebar, getMinIndex());
    slidebar->addTimeMarker(startmarker);
    
    endmarker = new BoundarySlider(slidebar, getMaxIndex());
    slidebar->addTimeMarker(endmarker);
    
    connect(slidebar->getIndexSlider(), SIGNAL(sliderReleased(Slider*, int)), this, SLOT(sliderReleased(Slider*, int)));
    connect(startmarker, SIGNAL(sliderReleased(Slider*, int)), this, SLOT(sliderReleased(Slider*, int)));
    connect(endmarker, SIGNAL(sliderReleased(Slider*, int)), this, SLOT(sliderReleased(Slider*, int)));
    connect(slidebar->getIndexSlider(), SIGNAL(sliderMoved(Slider*, int)), this, SLOT(sliderMoved(Slider*, int)));
    connect(startmarker, SIGNAL(sliderMoved(Slider*, int)), this, SLOT(sliderMoved(Slider*, int)));
    connect(endmarker, SIGNAL(sliderMoved(Slider*, int)), this, SLOT(sliderMoved(Slider*, int)));
    connect(slidebar->getIndexSlider(), SIGNAL(sliderClicked(Slider*)), this, SLOT(sliderClicked(Slider*)));
    connect(startmarker, SIGNAL(sliderClicked(Slider*)), this, SLOT(sliderClicked(Slider*)));
    connect(endmarker, SIGNAL(sliderClicked(Slider*)), this, SLOT(sliderClicked(Slider*)));
    connect(slidebar, SIGNAL(bookmarkClicked(int)), this, SLOT(bookmarkClickedSlot(int)));
    
    /* Timeout, at the moment only used for TestWidget */
    timer = new QTimer(this);
    timer->setInterval(25);
    connect(timer, SIGNAL(timeout()), this, SLOT(fireTimeout()));
    timer->start();
       
    updateScene();
}

Member Function Documentation

void Timeline::addBookmark ( int  idx )

slot

Adds a bookmark for the specified index. Only one bookmark per index is possible.

Definition at line 168 of file Timeline.cc.

                                  {
    if(hasBookmarkAtIndex(idx)) {
        return;
    }
    
    QVector<int> vec;
    vec << idx;
    addBookmarks(vec);
}

void Timeline::addBookmarks ( QVector< int >  bookmarks )

slot

Adds multiple bookmarks at once. See addBookmark().

Definition at line 178 of file Timeline.cc.

                                                  {
    Q_FOREACH(int bookmark, bookmarks) {
        this->bookmarks << bookmark;
    }
    slidebar->updateBookmarks(this->bookmarks);
}

void Timeline::bookmarkClicked ( int  idx )

signal

void Timeline::bookmarkRemoved ( int  idx )

signal

void Timeline::endMarkerClicked ( )

signal

void Timeline::endMarkerMoved ( int  idx )

signal

void Timeline::endMarkerReleased ( int  idx )

signal

const QColor & Timeline::getBackgroundColor ( ) const

slot

Definition at line 93 of file Timeline.cc.

                                                 {
    return bgColor;
}

int Timeline::getBookmarkHeight ( ) const

slot

Definition at line 69 of file Timeline.cc.

                                      {
    return bookmarkHeight;
}

int Timeline::getEndMarkerIndex ( )

slot

Returns the current index of the start marker.

Definition at line 149 of file Timeline.cc.

                                {
    return endmarker->getLastIndex();
}

int Timeline::getMarginLR ( )

slot

Definition at line 85 of file Timeline.cc.

                          {
    return marginLR;
}

int Timeline::getMarginTopBot ( )

slot

Definition at line 77 of file Timeline.cc.

                              {
    return marginTopBot;
}

int Timeline::getMaxIndex ( )

slot

Returns the maximum index, i.e. the highest index on the timeline.

Definition at line 296 of file Timeline.cc.

                          {
    return getMinIndex() + getSteps() * getStepSize();
}

int Timeline::getMinIndex ( )

slot

Definition at line 109 of file Timeline.cc.

                          {
    return minIndex;
}

int Timeline::getSliderIndex ( )

slot

Returns the current index of the index slider.

Definition at line 136 of file Timeline.cc.

                             {
    return slidebar->getIndexSlider()->getLastIndex();
}

int Timeline::getStartMarkerIndex ( )

slot

Returns the current index of the start marker.

Definition at line 140 of file Timeline.cc.

                                  {
    return startmarker->getLastIndex();
}

int Timeline::getSteps ( )

slot

Definition at line 118 of file Timeline.cc.

                       {
    return steps;
}

int Timeline::getStepSize ( )

slot

Definition at line 127 of file Timeline.cc.

                          {
    return stepSize;
}

int Timeline::getWidth ( )

slot

Definition at line 101 of file Timeline.cc.

                       {
    return ordered_width;
}

bool Timeline::hasBookmarkAtIndex ( int  idx )

slot

Returns true if there is a bookmark located at the specified index.

Definition at line 201 of file Timeline.cc.

                                         {
    for(int i = 0; i < bookmarks.size(); i++) {
        if (bookmarks.at(i) == idx) {
            return true;
        }
    }
    return false;
}

void Timeline::indexSliderClicked ( )

signal

void Timeline::indexSliderMoved ( int  idx )

signal

void Timeline::indexSliderReleased ( int  idx )

signal

void Timeline::removeAllBookmarks ( )

slot

Removes all bookmarks.

Definition at line 196 of file Timeline.cc.

                                  {
    bookmarks.clear();
    slidebar->updateBookmarks(bookmarks);
}

void Timeline::removeBookmark ( int  idx )

slot

Removes the bookmark at the specified index if there one.

Definition at line 185 of file Timeline.cc.

                                     {
    for(int i = 0; i < bookmarks.size(); i++) {
        if (bookmarks.at(i) == idx) {
            bookmarks.remove(i);    
            emit bookmarkRemoved(idx);
            slidebar->updateBookmarks(bookmarks);
            break;
        }
    }
}

void Timeline::resizeEvent ( QResizeEvent *  event )

protected

Definition at line 210 of file Timeline.cc.

                                               {
    QSize size = event->size();
    updateScene(size);
}

void Timeline::setBackgroundColor ( const QColor &  color )

slot

Definition at line 97 of file Timeline.cc.

                                                      {
    bgColor = color;
}

void Timeline::setBookmarkHeight ( int  height )

slot

Definition at line 73 of file Timeline.cc.

                                           {
    bookmarkHeight = height;
}

void Timeline::setEndMarkerIndex ( int  idx )

slot

Sets the index of the end marker.

Definition at line 153 of file Timeline.cc.

                                        {
    setSliderIndex(idx, endmarker);
}

void Timeline::setMarginLR ( int  margin )

slot

Definition at line 89 of file Timeline.cc.

                                     {
    marginLR = margin;
}

void Timeline::setMarginTopBot ( int  margin )

slot

Definition at line 81 of file Timeline.cc.

                                         {
    marginTopBot = margin;
}

void Timeline::setMinIndex ( int  minIndex )

slot

Definition at line 113 of file Timeline.cc.

                                       {
    this->minIndex = minIndex;
    reconfigure_slidebar = true;
}

void Timeline::setSliderIndex ( int  idx )

slot

Sets the index of the index slider.

Definition at line 157 of file Timeline.cc.

                                     {
    setSliderIndex(idx, slidebar->getIndexSlider());
}

void Timeline::setStartMarkerIndex ( int  idx )

slot

Sets the index of the start marker.

Definition at line 144 of file Timeline.cc.

                                          {
    setSliderIndex(idx, startmarker);
    
}

void Timeline::setSteps ( int  steps )

slot

Definition at line 122 of file Timeline.cc.

                                 {
    this->steps = steps;
    reconfigure_slidebar = true;
}

void Timeline::setStepSize ( int  stepSize )

slot

Definition at line 131 of file Timeline.cc.

                                       {
    this->stepSize = stepSize;
    reconfigure_slidebar = true;
}

void Timeline::setWidth ( int  width )

slot

Definition at line 105 of file Timeline.cc.

                                 {
    ordered_width = width;
}

void Timeline::startMarkerClicked ( )

signal

void Timeline::startMarkerMoved ( int  idx )

signal

void Timeline::startMarkerReleased ( int  idx )

signal

void Timeline::timeout ( )

signal

Property Documentation

QColor Timeline::backgroundColor

readwrite

Definition at line 31 of file Timeline.h.

int Timeline::bookmark_height

readwrite

Definition at line 28 of file Timeline.h.

int Timeline::margin_lr

readwrite

Definition at line 30 of file Timeline.h.

int Timeline::margin_topbot

readwrite

Definition at line 29 of file Timeline.h.

unsigned minIndex Timeline::READ

write

Definition at line 33 of file Timeline.h.

unsigned stepSize Timeline::READ

write

Definition at line 35 of file Timeline.h.

unsigned steps Timeline::READ

write

Definition at line 34 of file Timeline.h.

int Timeline::width

readwrite

Definition at line 32 of file Timeline.h.

---

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

• /build/rock-master-18.09-gui-rock-widget-collection-0.20180124/src/timeline/Timeline.h
• /build/rock-master-18.09-gui-rock-widget-collection-0.20180124/src/timeline/Timeline.cc