src/Utils/DropFiles.h

   1 // TortoiseSVN - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2006-2007 - TortoiseSVN
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #pragma once
  20
  21 #ifndef __DROPFILES_H__
  22 #define __DROPFILES_H__
  23
  24 #include <shlobj.h>
  25 #include <afxcoll.h>
  26
  27 /**
  28  * \ingroup Utils
  29  * Use this class to create the DROPFILES structure which is needed to
  30  * support drag and drop of file names to other applications.
  31  * Based on an example by Thomas Blenkers.
  32  */
  33 class CDropFiles
  34 {
  35 public:
  36         CDropFiles();
  37         ~CDropFiles();
  38
  39         /**
  40          * Add a file with an absolute file name. This file will later be
  41          * included the DROPFILES structure.
  42          */
  43         void AddFile(const CString &sFile);
  44
  45         /**
  46          * Returns the number of files which have been added
  47          */
  48         INT_PTR GetCount();
  49
  50         /**
  51          * Call this method when dragging begins. It will fill
  52          * the DROPFILES structure with the files previously
  53          * added with AddFile(...)
  54          */
  55         void CreateStructure();
  56
  57 protected:
  58         /**
  59          * CreateBuffer must be called once when all files have been added
  60          */
  61         void CreateBuffer();
  62
  63         /**
  64          * Returns a pointer to the buffer containing the DROPFILES
  65          * structure
  66          */
  67         void* GetBuffer() const;
  68
  69         /**
  70          * Returns the size of the buffer in bytes
  71          */
  72         int GetBufferSize() const;
  73
  74 protected:
  75         CStringArray m_arFiles;
  76
  77         char* m_pBuffer;
  78         int      m_nBufferSize;
  79 };
  80
  81 #endif