Changeset 103631 in vbox for trunk/include

Timestamp:

Mar 1, 2024 11:00:38 AM (14 months ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

161991

Message:

Shared Clipboard: More cleanups (renaming Windows parts to match the other platforms). bugref:9437

File:

• trunk/include/VBox/GuestHost/SharedClipboard-win.h (modified) (10 diffs)

trunk/include/VBox/GuestHost/SharedClipboard-win.h

@@ -113 +113 @@
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
 /** Forward declaration for the Windows data object. */
-class SharedClipboardWinDataObject;
+class ShClWinDataObject;
 #endif
 
@@ -143 +143 @@
      *  hasn't been started yet.
      *  Can be NULL if currently not being used / no current "in-flight" transfer present. */
-    SharedClipboardWinDataObject
-                      *pDataObjInFlight;
+    ShClWinDataObject *pDataObjInFlight;
 #endif
     /** Request queue.
@@ -151 +150 @@
 } SHCLWINCTX, *PSHCLWINCTX;
 
-int SharedClipboardWinOpen(HWND hWnd);
-int SharedClipboardWinClose(void);
-int SharedClipboardWinClear(void);
-
-int SharedClipboardWinCtxInit(PSHCLWINCTX pWinCtx);
-void SharedClipboardWinCtxDestroy(PSHCLWINCTX pWinCtx);
-
-int SharedClipboardWinCheckAndInitNewAPI(PSHCLWINAPINEW pAPI);
-bool SharedClipboardWinIsNewAPI(PSHCLWINAPINEW pAPI);
-
-int SharedClipboardWinDataWrite(UINT cfFormat, void *pvData, uint32_t cbData);
-
-int SharedClipboardWinChainAdd(PSHCLWINCTX pCtx);
-int SharedClipboardWinChainRemove(PSHCLWINCTX pCtx);
-VOID CALLBACK SharedClipboardWinChainPingProc(HWND hWnd, UINT uMsg, ULONG_PTR dwData, LRESULT lResult) RT_NOTHROW_DEF;
-LRESULT SharedClipboardWinChainPassToNext(PSHCLWINCTX pWinCtx, UINT msg, WPARAM wParam, LPARAM lParam);
-
-SHCLFORMAT SharedClipboardWinClipboardFormatToVBox(UINT uFormat);
-int SharedClipboardWinGetFormats(PSHCLWINCTX pCtx, PSHCLFORMATS pfFormats);
-
-int SharedClipboardWinGetCFHTMLHeaderValue(const char *pszSrc, const char *pszOption, uint32_t *puValue);
-bool SharedClipboardWinIsCFHTML(const char *pszSource);
-int SharedClipboardWinConvertCFHTMLToMIME(const char *pszSource, const uint32_t cch, char **ppszOutput, uint32_t *pcbOutput);
-int SharedClipboardWinConvertMIMEToCFHTML(const char *pszSource, size_t cb, char **ppszOutput, uint32_t *pcbOutput);
-
-LRESULT SharedClipboardWinHandleWMChangeCBChain(PSHCLWINCTX pWinCtx, HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam);
-int SharedClipboardWinHandleWMDestroy(PSHCLWINCTX pWinCtx);
-int SharedClipboardWinHandleWMRenderAllFormats(PSHCLWINCTX pWinCtx, HWND hWnd);
-int SharedClipboardWinHandleWMTimer(PSHCLWINCTX pWinCtx);
-
-int SharedClipboardWinClearAndAnnounceFormats(PSHCLWINCTX pWinCtx, SHCLFORMATS fFormats, HWND hWnd);
+int ShClWinOpen(HWND hWnd);
+int ShClWinClose(void);
+int ShClWinClear(void);
+
+int ShClWinCtxInit(PSHCLWINCTX pWinCtx);
+void ShClWinCtxDestroy(PSHCLWINCTX pWinCtx);
+
+int ShClWinCheckAndInitNewAPI(PSHCLWINAPINEW pAPI);
+bool ShClWinIsNewAPI(PSHCLWINAPINEW pAPI);
+
+int ShClWinDataWrite(UINT cfFormat, void *pvData, uint32_t cbData);
+
+int ShClWinChainAdd(PSHCLWINCTX pCtx);
+int ShClWinChainRemove(PSHCLWINCTX pCtx);
+VOID CALLBACK ShClWinChainPingProc(HWND hWnd, UINT uMsg, ULONG_PTR dwData, LRESULT lResult) RT_NOTHROW_DEF;
+LRESULT ShClWinChainPassToNext(PSHCLWINCTX pWinCtx, UINT msg, WPARAM wParam, LPARAM lParam);
+
+SHCLFORMAT ShClWinClipboardFormatToVBox(UINT uFormat);
+int ShClWinGetFormats(PSHCLWINCTX pCtx, PSHCLFORMATS pfFormats);
+
+int ShClWinGetCFHTMLHeaderValue(const char *pszSrc, const char *pszOption, uint32_t *puValue);
+bool ShClWinIsCFHTML(const char *pszSource);
+int ShClWinConvertCFHTMLToMIME(const char *pszSource, const uint32_t cch, char **ppszOutput, uint32_t *pcbOutput);
+int ShClWinConvertMIMEToCFHTML(const char *pszSource, size_t cb, char **ppszOutput, uint32_t *pcbOutput);
+
+LRESULT ShClWinHandleWMChangeCBChain(PSHCLWINCTX pWinCtx, HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam);
+int ShClWinHandleWMDestroy(PSHCLWINCTX pWinCtx);
+int ShClWinHandleWMRenderAllFormats(PSHCLWINCTX pWinCtx, HWND hWnd);
+int ShClWinHandleWMTimer(PSHCLWINCTX pWinCtx);
+
+int ShClWinClearAndAnnounceFormats(PSHCLWINCTX pWinCtx, SHCLFORMATS fFormats, HWND hWnd);
 
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
@@ -190 +189 @@
 
 /**
- * Generic Windows class implementing IDataObject for Shared Clipboard data transfers.
- */
-class SharedClipboardWinDataObject : public IDataObject //, public IDataObjectAsyncCapability
+ * Shared CLipboard Windows class implementing IDataObject for Shared Clipboard data transfers.
+ */
+class ShClWinDataObject : public IDataObject //, public IDataObjectAsyncCapability
 {
 public:
@@ -202 +201 @@
     {
         /** Pointer to the data object of this callback. */
-        SharedClipboardWinDataObject *pThis;
+        ShClWinDataObject *pThis;
         /** User-supplied pointer to more context data. */
         void                         *pvUser;
@@ -253 +252 @@
 public:
 
-    SharedClipboardWinDataObject(void);
-    virtual ~SharedClipboardWinDataObject(void);
-
-public:
-
-    int Init(PSHCLCONTEXT pCtx, SharedClipboardWinDataObject::PCALLBACKS pCallbacks, LPFORMATETC pFormatEtc = NULL, LPSTGMEDIUM pStgMed = NULL, ULONG cFormats = 0);
+    ShClWinDataObject(void);
+    virtual ~ShClWinDataObject(void);
+
+public:
+
+    int Init(PSHCLCONTEXT pCtx, ShClWinDataObject::PCALLBACKS pCallbacks, LPFORMATETC pFormatEtc = NULL, LPSTGMEDIUM pStgMed = NULL, ULONG cFormats = 0);
     void Uninit(void);
     void Destroy(void);
@@ -382 +381 @@
  * Generic Windows class implementing IEnumFORMATETC for Shared Clipboard data transfers.
  */
-class SharedClipboardWinEnumFormatEtc : public IEnumFORMATETC
-{
-public:
-
-    SharedClipboardWinEnumFormatEtc(void);
-    virtual ~SharedClipboardWinEnumFormatEtc(void);
+class ShClWinEnumFormatEtc : public IEnumFORMATETC
+{
+public:
+
+    ShClWinEnumFormatEtc(void);
+    virtual ~ShClWinEnumFormatEtc(void);
 
 public:
@@ -423 +422 @@
  * Generic Windows class implementing IStream for Shared Clipboard data transfers.
  */
-class SharedClipboardWinStreamImpl : public IStream
-{
-public:
-
-    SharedClipboardWinStreamImpl(SharedClipboardWinDataObject *pParent, PSHCLTRANSFER pTransfer,
-                                 const Utf8Str &strPath, PSHCLFSOBJINFO pObjInfo);
-    virtual ~SharedClipboardWinStreamImpl(void);
+class ShClWinStreamImpl : public IStream
+{
+public:
+
+    ShClWinStreamImpl(ShClWinDataObject *pParent, PSHCLTRANSFER pTransfer,
+                      const Utf8Str &strPath, PSHCLFSOBJINFO pObjInfo);
+    virtual ~ShClWinStreamImpl(void);
 
 public: /* IUnknown methods. */
@@ -453 +452 @@
 public: /* Own methods. */
 
-    static HRESULT Create(SharedClipboardWinDataObject *pParent, PSHCLTRANSFER pTransfer, const Utf8Str &strPath,
+    static HRESULT Create(ShClWinDataObject *pParent, PSHCLTRANSFER pTransfer, const Utf8Str &strPath,
                           PSHCLFSOBJINFO pObjInfo, IStream **ppStream);
 private:
 
     /** Pointer to the parent data object. */
-    SharedClipboardWinDataObject  *m_pParent;
+    ShClWinDataObject             *m_pParent;
     /** The stream object's current reference count. */
     LONG                           m_lRefCount;
@@ -479 +478 @@
  * Set as pvUser / cbUser for SHCLTRANSFER on Windows hosts / guests.
  */
-class SharedClipboardWinTransferCtx
-{
-public:
-    SharedClipboardWinTransferCtx()
+class ShClWinTransferCtx
+{
+public:
+    ShClWinTransferCtx()
         : pDataObj(NULL) { }
 
-    virtual ~SharedClipboardWinTransferCtx() { }
+    virtual ~ShClWinTransferCtx() { }
 
     /** Pointer to data object to use for this transfer. Not owned.
      *  Can be NULL if not being used. */
-    SharedClipboardWinDataObject *pDataObj;
+    ShClWinDataObject *pDataObj;
 };
 
-int SharedClipboardWinTransferGetRoots(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
-int SharedClipboardWinTransferDropFilesToStringList(DROPFILES *pDropFiles, char **papszList, uint32_t *pcbList);
-int SharedClipboardWinTransferGetRootsFromClipboard(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
-
-int SharedClipboardWinTransferCreate(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
-void SharedClipboardWinTransferDestroy(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
-
-int SharedClipboardWinTransferCreateAndSetDataObject(PSHCLWINCTX pWinCtx, PSHCLCONTEXT pCtx, SharedClipboardWinDataObject::PCALLBACKS pCallbacks);
-int SharedClipboardWinTransferInitialize(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
-int SharedClipboardWinTransferStart(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
+int ShClWinTransferGetRoots(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
+int ShClWinTransferDropFilesToStringList(DROPFILES *pDropFiles, char **papszList, uint32_t *pcbList);
+int ShClWinTransferGetRootsFromClipboard(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
+
+int ShClWinTransferCreate(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
+void ShClWinTransferDestroy(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
+
+int ShClWinTransferCreateAndSetDataObject(PSHCLWINCTX pWinCtx, PSHCLCONTEXT pCtx, ShClWinDataObject::PCALLBACKS pCallbacks);
+int ShClWinTransferInitialize(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
+int ShClWinTransferStart(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer);
 # endif /* VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS */
 #endif /* !VBOX_INCLUDED_GuestHost_SharedClipboard_win_h */