avmedia/inc/avmedia/mediaitem.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: mediaitem.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _AVMEDIA_MEDIAITEM_HXX
  32 #define _AVMEDIA_MEDIAITEM_HXX
  33
  34 #include <tools/rtti.hxx>
  35 #ifndef _POOLITEM_HXX
  36 #include <svtools/poolitem.hxx>
  37 #endif
  38 #include <com/sun/star/media/ZoomLevel.hpp>
  39
  40 #define AVMEDIA_SETMASK_NONE            ((sal_uInt32)(0x00000000))
  41 #define AVMEDIA_SETMASK_STATE           ((sal_uInt32)(0x00000001))
  42 #define AVMEDIA_SETMASK_DURATION        ((sal_uInt32)(0x00000002))
  43 #define AVMEDIA_SETMASK_TIME            ((sal_uInt32)(0x00000004))
  44 #define AVMEDIA_SETMASK_LOOP            ((sal_uInt32)(0x00000008))
  45 #define AVMEDIA_SETMASK_MUTE            ((sal_uInt32)(0x00000010))
  46 #define AVMEDIA_SETMASK_VOLUMEDB        ((sal_uInt32)(0x00000020))
  47 #define AVMEDIA_SETMASK_ZOOM            ((sal_uInt32)(0x00000040))
  48 #define AVMEDIA_SETMASK_URL                     ((sal_uInt32)(0x00000080))
  49 #define AVMEDIA_SETMASK_ALL                     ((sal_uInt32)(0xffffffff))
  50
  51 class SvStream;
  52
  53 namespace avmedia
  54 {
  55
  56 //---------------
  57 // - MediaState -
  58 // --------------
  59
  60 enum MediaState
  61 {
  62     MEDIASTATE_STOP = 0,
  63     MEDIASTATE_PLAY = 1,
  64     MEDIASTATE_PLAYFFW = 2,
  65     MEDIASTATE_PAUSE = 3
  66 };
  67
  68 // -------------
  69 // - MediaItem -
  70 // -------------
  71
  72 class MediaItem : public SfxPoolItem
  73 {
  74 public:
  75                             TYPEINFO();
  76
  77                             MediaItem( USHORT nWhich = 0, sal_uInt32 nMaskSet = AVMEDIA_SETMASK_NONE );
  78                             MediaItem( const MediaItem& rMediaItem );
  79     virtual                                     ~MediaItem();
  80
  81     virtual     int                             operator==( const SfxPoolItem& ) const;
  82     virtual SfxPoolItem*        Clone( SfxItemPool* pPool = 0 ) const;
  83     virtual SfxItemPresentation GetPresentation( SfxItemPresentation ePres,
  84                                                  SfxMapUnit eCoreUnit,
  85                                                  SfxMapUnit ePresUnit,
  86                                                  XubString& rText,
  87                                                  const IntlWrapper *pIntl ) const;
  88     virtual     BOOL                    QueryValue( com::sun::star::uno::Any& rVal, BYTE nMemberId = 0 ) const;
  89     virtual     BOOL                    PutValue( const com::sun::star::uno::Any& rVal, BYTE nMemberId = 0 );
  90
  91     void                                        merge( const MediaItem& rMediaItem );
  92
  93     sal_uInt32                          getMaskSet() const;
  94
  95     void                                        setState( MediaState eState );
  96     MediaState                          getState() const;
  97
  98     void                                        setDuration( double fDuration );
  99     double                                      getDuration() const;
 100
 101     void                                        setTime( double fTime );
 102     double                                      getTime() const;
 103
 104     void                                        setLoop( sal_Bool bLoop );
 105     sal_Bool                            isLoop() const;
 106
 107     void                                        setMute( sal_Bool bMute );
 108     sal_Bool                            isMute() const;
 109
 110     void                                        setVolumeDB( sal_Int16 nDB );
 111     sal_Int16                           getVolumeDB() const;
 112
 113     void                                        setZoom( ::com::sun::star::media::ZoomLevel eZoom );
 114     ::com::sun::star::media::ZoomLevel  getZoom() const;
 115
 116     void                                        setURL( const ::rtl::OUString& rURL );
 117     const ::rtl::OUString&  getURL() const;
 118
 119 private:
 120
 121     ::rtl::OUString                     maURL;
 122     sal_uInt32                          mnMaskSet;
 123     MediaState                          meState;
 124     double                                      mfTime;
 125     double                                      mfDuration;
 126     sal_Int16                           mnVolumeDB;
 127     sal_Bool                            mbLoop;
 128     sal_Bool                            mbMute;
 129     ::com::sun::star::media::ZoomLevel meZoom;
 130 };
 131
 132 typedef ::avmedia::MediaItem avmedia_MediaItem;
 133
 134 }
 135
 136 #endif