2001-09-28 20:14:13 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
2004-04-18 22:01:16 +00:00
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
1999-03-25 04:38:25 +00:00
|
|
|
*
|
2004-04-18 22:01:16 +00:00
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
1999-03-25 04:38:25 +00:00
|
|
|
*
|
2001-09-28 20:14:13 +00:00
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
1999-03-25 04:38:25 +00:00
|
|
|
*
|
1999-11-06 03:40:37 +00:00
|
|
|
* The Original Code is mozilla.org code.
|
|
|
|
*
|
2004-04-18 22:01:16 +00:00
|
|
|
* The Initial Developer of the Original Code is
|
2001-09-28 20:14:13 +00:00
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
1999-11-06 03:40:37 +00:00
|
|
|
*
|
2001-09-28 20:14:13 +00:00
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
2004-04-18 22:01:16 +00:00
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
2001-09-28 20:14:13 +00:00
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
2004-04-18 22:01:16 +00:00
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
2001-09-28 20:14:13 +00:00
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
2004-04-18 22:01:16 +00:00
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
2001-09-28 20:14:13 +00:00
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
1999-03-25 04:38:25 +00:00
|
|
|
|
1999-03-23 15:37:34 +00:00
|
|
|
#ifndef _NSDATAOBJ_H_
|
|
|
|
#define _NSDATAOBJ_H_
|
|
|
|
|
2003-03-14 23:35:18 +00:00
|
|
|
#include <unknwn.h>
|
|
|
|
#include <basetyps.h>
|
|
|
|
#include <objidl.h>
|
|
|
|
// The above are required for __MINGW32__
|
|
|
|
#include <oleidl.h>
|
1999-03-23 15:37:34 +00:00
|
|
|
|
1999-03-23 17:12:23 +00:00
|
|
|
//#include "Ddforw.h"
|
1999-03-23 15:37:34 +00:00
|
|
|
#include "nsString.h"
|
2003-06-06 23:30:47 +00:00
|
|
|
#include "nsILocalFile.h"
|
1999-03-23 15:37:34 +00:00
|
|
|
|
|
|
|
#define MAX_FORMATS 32
|
|
|
|
|
1999-05-13 21:53:57 +00:00
|
|
|
class nsVoidArray;
|
1999-03-23 15:37:34 +00:00
|
|
|
class CEnumFormatEtc;
|
|
|
|
class nsITransferable;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This ole registered class is used to facilitate drag-drop of objects which
|
|
|
|
* can be adapted by an object derived from CfDragDrop. The CfDragDrop is
|
|
|
|
* associated with instances via SetDragDrop().
|
|
|
|
*/
|
|
|
|
class nsDataObj : public IDataObject
|
|
|
|
{
|
|
|
|
public: // construction, destruction
|
|
|
|
nsDataObj();
|
|
|
|
~nsDataObj();
|
|
|
|
|
|
|
|
public: // IUnknown methods - see iunknown.h for documentation
|
|
|
|
STDMETHODIMP_(ULONG) AddRef ();
|
|
|
|
STDMETHODIMP QueryInterface(REFIID, void**);
|
|
|
|
STDMETHODIMP_(ULONG) Release ();
|
|
|
|
|
|
|
|
// support for clipboard
|
1999-09-04 20:04:26 +00:00
|
|
|
void AddDataFlavor(const char* aDataFlavor, LPFORMATETC aFE);
|
1999-03-23 15:37:34 +00:00
|
|
|
void SetTransferable(nsITransferable * aTransferable);
|
|
|
|
|
|
|
|
// Return the registered OLE class ID of this object's CfDataObj.
|
|
|
|
CLSID GetClassID() const;
|
|
|
|
|
|
|
|
public: // IDataObject methods - these are general comments. see CfDragDrop
|
|
|
|
// for overriding behavior
|
|
|
|
|
|
|
|
// Store data in pSTM according to the format specified by pFE, if the
|
|
|
|
// format is supported (supported formats are specified in CfDragDrop::
|
|
|
|
// GetFormats) and return NOERROR; otherwise return DATA_E_FORMATETC. It
|
|
|
|
// is the callers responsibility to free pSTM if NOERROR is returned.
|
|
|
|
STDMETHODIMP GetData (LPFORMATETC pFE, LPSTGMEDIUM pSTM);
|
|
|
|
|
|
|
|
// Similar to GetData except that the caller allocates the structure
|
|
|
|
// referenced by pSTM.
|
|
|
|
STDMETHODIMP GetDataHere (LPFORMATETC pFE, LPSTGMEDIUM pSTM);
|
|
|
|
|
|
|
|
// Returns S_TRUE if this object supports the format specified by pSTM,
|
|
|
|
// S_FALSE otherwise.
|
|
|
|
STDMETHODIMP QueryGetData (LPFORMATETC pFE);
|
|
|
|
|
|
|
|
// Set pCanonFE to the cannonical format of pFE if one exists and return
|
|
|
|
// NOERROR, otherwise return DATA_S_SAMEFORMATETC. A cannonical format
|
|
|
|
// implies an identical rendering.
|
|
|
|
STDMETHODIMP GetCanonicalFormatEtc (LPFORMATETC pFE, LPFORMATETC pCanonFE);
|
|
|
|
|
|
|
|
// Set this objects data according to the format specified by pFE and
|
|
|
|
// the storage medium specified by pSTM and return NOERROR, if the format
|
|
|
|
// is supported. If release is TRUE this object must release the storage
|
|
|
|
// associated with pSTM.
|
|
|
|
STDMETHODIMP SetData (LPFORMATETC pFE, LPSTGMEDIUM pSTM, BOOL release);
|
|
|
|
|
|
|
|
// Set ppEnum to an IEnumFORMATETC object which will iterate all of the
|
|
|
|
// data formats that this object supports. direction is either DATADIR_GET
|
|
|
|
// or DATADIR_SET.
|
|
|
|
STDMETHODIMP EnumFormatEtc (DWORD direction, LPENUMFORMATETC* ppEnum);
|
|
|
|
|
|
|
|
// Set up an advisory connection to this object based on the format specified
|
|
|
|
// by pFE, flags, and the pAdvise. Set pConn to the established advise
|
|
|
|
// connection.
|
|
|
|
STDMETHODIMP DAdvise (LPFORMATETC pFE, DWORD flags, LPADVISESINK pAdvise,
|
|
|
|
DWORD* pConn);
|
|
|
|
|
|
|
|
// Turn off advising of a previous call to DAdvise which set pConn.
|
|
|
|
STDMETHODIMP DUnadvise (DWORD pConn);
|
|
|
|
|
|
|
|
// Set ppEnum to an IEnumSTATDATA object which will iterate over the
|
|
|
|
// existing objects which have established advisory connections to this
|
|
|
|
// object.
|
|
|
|
STDMETHODIMP EnumDAdvise (LPENUMSTATDATA *ppEnum);
|
|
|
|
|
|
|
|
public: // other methods
|
|
|
|
|
|
|
|
// Return the total reference counts of all instances of this class.
|
|
|
|
static ULONG GetCumRefCount();
|
|
|
|
|
|
|
|
// Return the reference count (which helps determine if another app has
|
|
|
|
// released the interface pointer after a drop).
|
|
|
|
ULONG GetRefCount() const;
|
|
|
|
|
|
|
|
protected:
|
2000-05-02 22:39:08 +00:00
|
|
|
|
|
|
|
// Help determine if the drag should create an internet shortcut
|
|
|
|
PRBool IsInternetShortcut ( ) ;
|
|
|
|
|
|
|
|
virtual HRESULT AddSetFormat(FORMATETC& FE);
|
|
|
|
virtual HRESULT AddGetFormat(FORMATETC& FE);
|
|
|
|
|
2002-03-23 22:26:36 +00:00
|
|
|
virtual HRESULT GetText ( const nsACString& aDF, FORMATETC& aFE, STGMEDIUM & aSTG );
|
2003-06-06 23:30:47 +00:00
|
|
|
virtual HRESULT GetFile ( const nsACString& aDF, FORMATETC& aFE, STGMEDIUM& aSTG );
|
2002-03-23 22:26:36 +00:00
|
|
|
virtual HRESULT GetBitmap ( const nsACString& inFlavor, FORMATETC& FE, STGMEDIUM& STM);
|
|
|
|
virtual HRESULT GetDib ( const nsACString& inFlavor, FORMATETC &, STGMEDIUM & aSTG );
|
2000-05-02 22:39:08 +00:00
|
|
|
virtual HRESULT GetMetafilePict(FORMATETC& FE, STGMEDIUM& STM);
|
|
|
|
|
2002-11-05 12:51:39 +00:00
|
|
|
virtual HRESULT GetUniformResourceLocator ( FORMATETC& aFE, STGMEDIUM& aSTG ) ;
|
|
|
|
virtual HRESULT ExtractUniformResourceLocator ( FORMATETC& aFE, STGMEDIUM& aSTG ) ;
|
2000-05-02 22:39:08 +00:00
|
|
|
virtual HRESULT GetFileDescriptor ( FORMATETC& aFE, STGMEDIUM& aSTG ) ;
|
|
|
|
virtual HRESULT GetFileContents ( FORMATETC& aFE, STGMEDIUM& aSTG ) ;
|
2003-06-06 23:30:47 +00:00
|
|
|
virtual HRESULT GetPreferredDropEffect ( FORMATETC& aFE, STGMEDIUM& aSTG );
|
2000-05-02 22:39:08 +00:00
|
|
|
|
|
|
|
virtual HRESULT SetBitmap(FORMATETC& FE, STGMEDIUM& STM);
|
|
|
|
virtual HRESULT SetDib (FORMATETC& FE, STGMEDIUM& STM);
|
|
|
|
virtual HRESULT SetText (FORMATETC& FE, STGMEDIUM& STM);
|
|
|
|
virtual HRESULT SetMetafilePict(FORMATETC& FE, STGMEDIUM& STM);
|
|
|
|
|
|
|
|
// Provide the structures needed for an internet shortcut by the shell
|
|
|
|
virtual HRESULT GetFileDescriptorInternetShortcut ( FORMATETC& aFE, STGMEDIUM& aSTG ) ;
|
|
|
|
virtual HRESULT GetFileContentsInternetShortcut ( FORMATETC& aFE, STGMEDIUM& aSTG ) ;
|
|
|
|
|
2000-06-09 03:21:01 +00:00
|
|
|
nsresult ExtractShortcutURL ( nsString & outURL ) ;
|
|
|
|
nsresult ExtractShortcutTitle ( nsString & outTitle ) ;
|
2001-02-20 23:27:57 +00:00
|
|
|
|
|
|
|
// munge our HTML data to win32's CF_HTML spec. Will null terminate
|
|
|
|
nsresult BuildPlatformHTML ( const char* inOurHTML, char** outPlatformHTML ) ;
|
2000-06-05 00:34:11 +00:00
|
|
|
|
1999-03-23 15:37:34 +00:00
|
|
|
nsString mStringData;
|
|
|
|
|
|
|
|
BOOL FormatsMatch(const FORMATETC& source, const FORMATETC& target) const;
|
|
|
|
|
1999-05-04 22:44:16 +00:00
|
|
|
static ULONG g_cRef; // the cum reference count of all instances
|
|
|
|
ULONG m_cRef; // the reference count
|
|
|
|
|
1999-05-13 21:53:57 +00:00
|
|
|
nsVoidArray * mDataFlavors; // we own and its contents
|
1999-05-04 22:44:16 +00:00
|
|
|
|
|
|
|
nsITransferable * mTransferable; // nsDataObj owns and ref counts nsITransferable,
|
|
|
|
// the nsITransferable does know anything about the nsDataObj
|
1999-03-23 15:37:34 +00:00
|
|
|
|
1999-05-04 22:44:16 +00:00
|
|
|
CEnumFormatEtc * m_enumFE; // Ownership Rules:
|
|
|
|
// nsDataObj owns and ref counts CEnumFormatEtc,
|
1999-03-23 15:37:34 +00:00
|
|
|
|
2003-06-06 23:30:47 +00:00
|
|
|
nsCOMPtr<nsILocalFile> mCachedTempFile;
|
1999-03-23 15:37:34 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
2001-02-20 23:27:57 +00:00
|
|
|
#endif // _NSDATAOBJ_H_
|
|
|
|
|