src/Utils/DropFiles.h

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