include/wx/msw/clipbrd.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        clipbrd.h
   3 // Purpose:     Clipboard functionality
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_CLIPBRD_H_
  13 #define _WX_CLIPBRD_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "clipbrd.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20 #include "wx/setup.h"
  21
  22 #if wxUSE_CLIPBOARD
  23
  24 #include "wx/list.h"
  25 #include "wx/module.h"
  26 #include "wx/dataobj.h"     // for wxDataFormat
  27
  28 // These functions superceded by wxClipboard, but retained in order to
  29 // implement wxClipboard, and for compatibility.
  30
  31 // open/close the clipboard
  32 WXDLLEXPORT bool wxOpenClipboard();
  33 WXDLLEXPORT bool wxIsClipboardOpened();
  34 #define wxClipboardOpen wxIsClipboardOpened
  35 WXDLLEXPORT bool wxCloseClipboard();
  36
  37 // get/set data
  38 WXDLLEXPORT bool wxEmptyClipboard();
  39 WXDLLEXPORT bool wxSetClipboardData(wxDataFormat dataFormat,
  40                                     const void *data,
  41                                     int width = 0, int height = 0);
  42 WXDLLEXPORT void* wxGetClipboardData(wxDataFormat dataFormat,
  43                                      long *len = NULL);
  44
  45 // clipboard formats
  46 WXDLLEXPORT bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat);
  47 WXDLLEXPORT wxDataFormat wxEnumClipboardFormats(wxDataFormat dataFormat);
  48 WXDLLEXPORT int  wxRegisterClipboardFormat(wxChar *formatName);
  49 WXDLLEXPORT bool wxGetClipboardFormatName(wxDataFormat dataFormat,
  50                                           wxChar *formatName,
  51                                           int maxCount);
  52
  53 //-----------------------------------------------------------------------------
  54 // wxClipboard
  55 //-----------------------------------------------------------------------------
  56
  57 class WXDLLEXPORT wxDataObject;
  58 class WXDLLEXPORT wxClipboard : public wxObject
  59 {
  60     DECLARE_DYNAMIC_CLASS(wxClipboard)
  61
  62 public:
  63     wxClipboard();
  64     ~wxClipboard();
  65
  66     // open the clipboard before SetData() and GetData()
  67     virtual bool Open();
  68
  69     // close the clipboard after SetData() and GetData()
  70     virtual void Close();
  71
  72     // set the clipboard data. all other formats will be deleted.
  73     virtual bool SetData( wxDataObject *data );
  74
  75     // add to the clipboard data.
  76     virtual bool AddData( wxDataObject *data );
  77
  78     // ask if data in correct format is available
  79     virtual bool IsSupported( wxDataFormat format );
  80
  81     // fill data with data on the clipboard (if available)
  82     virtual bool GetData( wxDataObject *data );
  83
  84     // clears wxTheClipboard and the system's clipboard if possible
  85     virtual void Clear();
  86
  87     /// X11 has two clipboards which get selected by this call. Empty on MSW.
  88     void UsePrimarySelection( bool WXUNUSED(primary) = FALSE ) { }
  89
  90 };
  91
  92 // The global clipboard object
  93 WXDLLEXPORT_DATA(extern wxClipboard*) wxTheClipboard;
  94
  95 //-----------------------------------------------------------------------------
  96 // wxClipboardModule: module responsible for initializing the global clipboard
  97 // object
  98 //-----------------------------------------------------------------------------
  99
 100 class wxClipboardModule : public wxModule
 101 {
 102     DECLARE_DYNAMIC_CLASS(wxClipboardModule)
 103
 104 public:
 105     wxClipboardModule() { }
 106
 107     bool OnInit();
 108     void OnExit();
 109 };
 110
 111 #endif // wxUSE_CLIPBOARD
 112 #endif
 113     // _WX_CLIPBRD_H_