include/wx/os2/clipbrd.h

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