fs_rendition.h

浏览该文件的文档.

#ifndef FS_RENDITION_H_
#define FS_RENDITION_H_

#include "common/fs_common.h"
#include "pdf/objects/fs_pdfobject.h"

namespace foxit {
namespace pdf {
// forward declaration
class FileSpec;
class MediaPlayer;

class Rendition FS_FINAL : public Base {
 public:
  typedef enum _MediaOptionType {
    e_MediaOptionMustBeHonored = 0,
    e_MediaOptionBestEffort = 1
  } MediaOptionType;
  
  typedef enum _MediaPermission {
    e_MediaPermTempNever = 0,
    e_MediaPermTempExtract = 1,
    e_MediaPermTempAccess = 2,
    e_MediaPermTempAlways = 3
  } MediaPermission;
  
  typedef enum _MediaPlayerType {
    e_MediaPlayerMustUsed = 0,
    e_MediaPlayerAvailable = 1,
    e_MediaPlayerNotUsed = 2
  } MediaPlayerType;
  
  typedef enum _MediaPlayerFitStyle {
    e_MediaPlayerFitStyleMeet = 0,
    e_MediaPlayerFitStyleSlice = 1,
    e_MediaPlayerFitStyleFill = 2,
    e_MediaPlayerFitStyleScroll = 3,
    e_MediaPlayerFitStyleHidden = 4,
    e_MediaPlayerFitStyleDefault = 5
  } MediaPlayerFitStyle;
  
  typedef enum _WindowType {
    e_WindowTypeFloating = 0,
    e_WindowTypeFullScreen = 1,
    e_WindowTypeHidden = 2,
    e_WindowTypeAnnotRect = 3
  } WindowType;
  
  typedef enum _MonitorSpecifier {
    e_MonitorSpecifierLargest = 0,
    e_MonitorSpecifierSmallest = 1,
    e_MonitorSpecifierPrimary = 2,
    e_MonitorSpecifierGreatestColorDepth = 3,
    e_MonitorSpecifierGreatestArea = 4,
    e_MonitorSpecifierGreatestHeight = 5,
    e_MonitorSpecifierGreatestWidth = 6
  } MonitorSpecifier;
  
  typedef enum _FloatingWindowRelatedWindowType {
    e_FloatingWindowRelatedWindowDocument = 0,
    e_FloatingWindowRelatedWindowApplication = 1,
    e_FloatingWindowRelatedWindowFullDesktop = 2,
    e_FloatingWindowRelatedWindowMonitor = 3
  } FloatingWindowRelatedWindowType;
  
  typedef enum _FloatingWindowResizeType {
    e_FloatingWindowResizeTypeNo = 0,
    e_FloatingWindowResizeTypeAspectRatio = 1,
    e_FloatingWindowResizeTypeAnyway = 2
  } FloatingWindowResizeType;
  
  typedef enum _FloatingWindowOffscreenEvent {
    e_FloatingWindowOffscreenEventNone = 0,
    e_FloatingWindowOffscreenEventMoveResize = 1,
    e_FloatingWindowOffscreenEventNonViable = 2
  } FloatingWindowOffscreenEvent;
  

  Rendition(const PDFDoc& pdf_doc, objects::PDFDictionary* rendition_dict = NULL);
  ~Rendition();

  Rendition(const Rendition& other);
  Rendition& operator = (const Rendition& other);
  bool operator == (const Rendition& other) const;
  bool operator != (const Rendition& other) const;
  bool IsEmpty() const;
  
  objects::PDFDictionary* GetDict() const;

  WString GetRenditionName() const;
  void SetRenditionName(const WString& name);

  bool HasMediaClip() const;
  WString GetMediaClipName() const;
  void SetMediaClipName(const WString& name);
  FileSpec GetMediaClipFile() const;
  void SetMediaClipFile(FileSpec file_specification);
 
  String GetMediaClipContentType() const;
  void SetMediaClipContentType(const char* content_type);
  
  MediaPermission GetPermission() const;
  void SetPermission(MediaPermission permission);

  WStringArray GetMediaDescriptions() const;
  void SetMediaDescriptions(const WStringArray &description_array);

  String GetMediaBaseURL() const;
  void SetMediaBaseURL(const String& base_url, MediaOptionType opt_type = e_MediaOptionBestEffort);

  int GetMediaPlayerCount(MediaPlayerType type) const;
  MediaPlayer GetMediaPlayer(MediaPlayerType type, int index) const;
  int AddMediaPlayer(MediaPlayerType type, const MediaPlayer &player);
  void RemoveMediaPlayer(MediaPlayerType type, const MediaPlayer &player);

  int GetVolume() const;
  void SetVolume(int volume, MediaOptionType opt_type = e_MediaOptionBestEffort);

  bool IsControlBarVisible() const;
  void EnableControlBarVisible(bool is_visible, MediaOptionType opt_type = e_MediaOptionBestEffort);

  MediaPlayerFitStyle GetFitStyle() const;
  void SetFitStyle(MediaPlayerFitStyle fit_style, MediaOptionType opt_type = e_MediaOptionBestEffort);

  int GetDuration() const;
  void SetDuration(int duration, MediaOptionType opt_type = e_MediaOptionBestEffort);

  bool IsAutoPlay() const;
  void EnableAutoPlay(bool is_auto_play, MediaOptionType opt_type = e_MediaOptionBestEffort);

  int GetRepeatCount() const;
  void SetRepeatCount(int count, MediaOptionType opt_type = e_MediaOptionBestEffort);

  WindowType GetWindowType() const;
  void SetWindowType(WindowType window_type, MediaOptionType opt_type = e_MediaOptionBestEffort);

  RGB GetBackgroundColor() const;
  void SetBackgroundColor(RGB color, MediaOptionType opt_type = e_MediaOptionBestEffort);

  float GetBackgroundOpacity() const;
  void SetBackgroundOpacity(float opacity, MediaOptionType opt_type = e_MediaOptionBestEffort);

  MonitorSpecifier GetMonitorSpecifier() const;
  void SetMonitorSpecifier(MonitorSpecifier monitor_specifier, MediaOptionType opt_type = e_MediaOptionBestEffort);

  int GetFloatingWindowWidth() const;
  int GetFloatingWindowHeight() const;
  void SetFloatingWindowSize(int width, int height, MediaOptionType opt_type = e_MediaOptionBestEffort);

  FloatingWindowRelatedWindowType GetFloatingWindowRelatedWindowType() const;
  void SetFloatingWindowRelatedWindowType(FloatingWindowRelatedWindowType window_type, MediaOptionType opt_type = e_MediaOptionBestEffort);

  common::Position GetFloatingWindowPosition() const;
  void SetFloatingWindowPosition(common::Position position, MediaOptionType opt_type = e_MediaOptionBestEffort);

  FloatingWindowOffscreenEvent GetFloatingWindowOffscreenEvent() const;
  void SetFloatingWindowOffscreenEvent(FloatingWindowOffscreenEvent offscreen_event, MediaOptionType opt_type = e_MediaOptionBestEffort);

  bool HasFloatingWindowTitleBar() const;
  void EnableFloatingWindowTitleBar(bool is_visible, MediaOptionType opt_type = e_MediaOptionBestEffort);

  bool HasFloatingWindowCloseButton() const;
  void EnableFloatingWindowCloseButton(bool is_visible, MediaOptionType opt_type = e_MediaOptionBestEffort);

  FloatingWindowResizeType GetFloatingWindowResizeType() const;
  void SetFloatingWindowResizeType(FloatingWindowResizeType resize_type, MediaOptionType opt_type = e_MediaOptionBestEffort);

  WStringArray GetFloatingWindowTitles() const;
  void SetFloatingWindowTitles(const WStringArray& titles, MediaOptionType opt_type = e_MediaOptionBestEffort);

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit Rendition(FS_HANDLE handle =  NULL);
};

class MediaPlayer FS_FINAL : public Base {
 public:
  MediaPlayer(objects::PDFDictionary* media_player_dict = NULL);

  ~MediaPlayer();

  MediaPlayer(const MediaPlayer& other);

  MediaPlayer& operator = (const MediaPlayer& other);

  bool operator == (const MediaPlayer& other) const;

  bool operator != (const MediaPlayer& other) const;

  bool IsEmpty() const;

  objects::PDFDictionary* GetDict() const;

  String GetSoftwareURI() const;

  void SetSoftwareURI(const String& uri);

  StringArray GetOSIdentifiers() const;

  void SetOSIdentifiers(const StringArray& identifier_array);

  // 强烈建议用户不要使用此方法；否则可能会出现未知情况。
  explicit MediaPlayer(FS_HANDLE handle);
};
}  // namespace pdf
}  // namespace foxit

#endif  // FS_RENDITION_H_