/****************************************************************************
**
** Copyright (C) 2008 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef INCLUDED_ITIMELINE_TIMEBAR_H
#define INCLUDED_ITIMELINE_TIMEBAR_H 1

#pragma once

#include "Qt3DSString.h"

class ITimeChangeCallback;

class CColor;

//=============================================================================
/**
 * Interface for a Timebar
 */
//=============================================================================
class ITimelineTimebar
{
public:
    virtual ~ITimelineTimebar() {}

    virtual long GetStartTime() const = 0;
    virtual long GetEndTime() const = 0;
    virtual long GetDuration() const = 0;
    virtual bool ShowHandleBars() const = 0;
    //=============================================================================
    /**
     * TODO: consider refactor. drag&drop specfics should not be in the Data Model.
     */
    virtual void OnBeginDrag() = 0;
    //
    virtual void OffsetTime(long inDiff) = 0;
    // Change the start time or the end time of the timebar. inTime: time to change to, inSetStart:
    // true to set start time, false to set end time.
    virtual void ChangeTime(long inTime, bool inSetStart) = 0;
    virtual void CommitTimeChange() = 0;
    virtual void RollbackTimeChange() = 0;
    //
    virtual CColor GetTimebarColor() = 0;
    virtual Q3DStudio::CString GetTimebarComment() = 0;
    virtual void SetTimebarComment(const Q3DStudio::CString &inComment) = 0;
    virtual void SetTimebarTime(ITimeChangeCallback *inCallback = nullptr) = 0;
};

#endif // INCLUDED_ITIMELINE_TIMEBAR_H