//
// Tizen Web Device API
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

#ifndef IMMS_SLIDE_PROPERTIES_H
#define IMMS_SLIDE_PROPERTIES_H

#include <string>

namespace DeviceAPI {
namespace Messaging {

class IMmsSlidePropertyImage
{
  public:
    typedef unsigned long Ulong;

  public:

    virtual ~IMmsSlidePropertyImage()
    {
    }

    /**
     * get image filename
     * */
    virtual const std::string& getImageFilename() const = 0;

    /**
     * get image filename
     * @param[in] picture filename
     * @throw MMS_MESSAGE_SIZE_EXCEEDED_ERROR
     * @throw MMS_VIDEO_SLIDE_ERROR
     * */
    virtual void setImageFilename(const std::string& filename) = 0;

    /**
     * get imageBegin
     * begining of image presentation within a slide in milisecond
     * */
    virtual Ulong getImageBegin() const = 0;

    /**
     * set imageBegin;
     * begining of image presentation within a slide in milisecond
     * @param[in] - value in miliseconds
     * */
    virtual void setImageBegin(Ulong value) = 0;

    /**
     * get imageEnd
     * end of image presentation within a slide in milisecond
     * */
    virtual Ulong getImageEnd() const = 0;

    /**
     * set imageBegin;
     * end of image presentation within a slide in milisecond
     * @param[in] - value in miliseconds
     * */
    virtual void setImageEnd(Ulong value) = 0;
};

//--------------------------------------------------------------------------

class IMmsSlidePropertyAudio
{
  public:
    typedef unsigned long Ulong;

  public:

    virtual ~IMmsSlidePropertyAudio()
    {
    }

    /**
     * get audio filename
     * */
    virtual const std::string& getAudioFilename() const = 0;

    /**
     * get audio filename
     * @param[in] audio filename
     * @throw MMS_MESSAGE_SIZE_EXCEEDED_ERROR
     * @throw MMS_VIDEO_SLIDE_ERROR
     * */
    virtual void setAudioFilename(const std::string& filename) = 0;

    /**
     * get audio begin
     * begining of image presentation within a slide in milisecond
     * */
    virtual Ulong getAudioBegin() const = 0;

    /**
     * set audio begin;
     * begining of audio presentation within a slide in milisecond
     * @param[in] - value in miliseconds
     * */
    virtual void setAudioBegin(Ulong value) = 0;

    /**
     * get audioEnd
     * end of audio presentation within a slide in milisecond
     * */
    virtual Ulong getAudioEnd() const = 0;

    /**
     * set audioEnd;
     * end of audio presentation within a slide in milisecond
     * @param[in] - value in miliseconds
     * */
    virtual void setAudioEnd(Ulong value) = 0;
};

//--------------------------------------------------------------------------

class IMmsSlidePropertyText
{
  public:
    typedef unsigned long Ulong;

  public:

    virtual ~IMmsSlidePropertyText()
    {
    }

    /**
     * get text filename
     * */
    virtual const std::string& getTextFilename() const = 0;

    /**
     * get text filename
     * @param[in] text filename
     * @throw MMS_MESSAGE_SIZE_EXCEEDED_ERROR
     * @throw MMS_VIDEO_SLIDE_ERROR
     * */
    virtual void setTextFilename(const std::string& filename) = 0;

    /**
     * get text begin
     * begining of text presentation within a slide in milisecond
     * */
    virtual Ulong getTextBegin() const = 0;

    /**
     * set text begin;
     * begining of text presentation within a slide in milisecond
     * @param[in] - value in miliseconds
     * */
    virtual void setTextBegin(Ulong value) = 0;

    /**
     * get textEnd
     * end of text presentation within a slide in milisecond
     * */
    virtual Ulong getTextEnd() const = 0;

    /**
     * set textEnd;
     * end of text presentation within a slide in milisecond
     * @param[in] - value in miliseconds
     * */
    virtual void setTextEnd(Ulong value) = 0;
};

//--------------------------------------------------------------------------

class IMmsSlidePropertyVideo
{
  public:
    typedef unsigned long Ulong;

  public:

    virtual ~IMmsSlidePropertyVideo()
    {
    }

    /**
     * get video filename
     * */
    virtual const std::string& getVideoFilename() const = 0;

    /**
     * get video filename
     * @param[in] vdeo filename
     * @throw MMS_MESSAGE_SIZE_EXCEEDED_ERROR
     * @throw MMS_VIDEO_SLIDE_ERROR
     * */
    virtual void setVideoFilename(const std::string& filename) = 0;

    /**
     * get video begin
     * begining of video presentation within a slide in milisecond
     * */
    virtual Ulong getVideoBegin() const = 0;

    /**
     * set video begin;
     * begining of video presentation within a slide in milisecond
     * @param[in] - value in miliseconds
     * */
    virtual void setVideoBegin(Ulong value) = 0;

    /**
     * get videoEnd
     * end of video presentation within a slide in milisecond
     * */
    virtual Ulong getVideoEnd() const = 0;

    /**
     * set videoEnd;
     * end of video presentation within a slide in milisecond
     * @param[in] - value in miliseconds
     * */
    virtual void setVideoEnd(Ulong value) = 0;
};
}
}
#endif