Main/Core/Services/IClipboardService.cs

   1 //-----------------------------------------------------------------------
   2 // <copyright file="IClipboardService.cs" company="Takayoshi Matsuyama">
   3 //     Copyright (c) Takayoshi Matsuyama. All rights reserved.
   4 // </copyright>
   5 //-----------------------------------------------------------------------
   6
   7 // This file is part of Simple Backup.
   8 //
   9 // Simple Backup is free software: you can redistribute it and/or modify
  10 // it under the terms of the GNU General Public License as published by
  11 // the Free Software Foundation, either version 3 of the License, or
  12 // (at your option) any later version.
  13 //
  14 // Simple Backup is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 // GNU General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 using System;
  23 using System.Windows;
  24
  25 namespace SimpleBackup.Core.Services
  26 {
  27     /// <summary>
  28     /// Provides clip board access.
  29     /// </summary>
  30     public interface IClipboardService
  31     {
  32         /// <summary>
  33         /// Sets the data object.
  34         /// </summary>
  35         /// <param name="dataObject">The data object.</param>
  36         /// <exception cref="ArgumentNullException">The data object is null.</exception>
  37         void SetDataObject(IDataObject dataObject);
  38
  39         /// <summary>
  40         /// Gets the data.
  41         /// </summary>
  42         /// <typeparam name="T">The type.</typeparam>
  43         /// <param name="format">The format.</param>
  44         /// <returns>
  45         /// The data.
  46         /// </returns>
  47         /// <exception cref="ArgumentException">The format string is null or empty.</exception>
  48         T GetData<T>(string format);
  49
  50         /// <summary>
  51         /// Gets a boolean value indicating whether the clipboard data contains data in specified format.
  52         /// </summary>
  53         /// <param name="format">The format.</param>
  54         /// <exception cref="ArgumentException">The format string is null or empty.</exception>
  55         /// <returns>True if the specified format is contained in the Clipboard.</returns>
  56         bool DoesClipboardDataContain(string format);
  57
  58         /// <summary>
  59         /// Clears the clipbord.
  60         /// </summary>
  61         void ClearClipbord();
  62     }
  63 }