SoWinClipboard.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
 
#ifndef  _SO_WIN_CLIPBOARD_
#define  _SO_WIN_CLIPBOARD_
 
#include <Inventor/sys/port.h>
 
#include <Inventor/Win/SoWin.h>
 
#include <Inventor/Win/SoWinBeginStrict.h>
 
 
class SbDict;
class SoByteStream;
class SoNode;
class SoPath;
class SoPathList;
class SoSelection;
 
 
// callback function prototypes
typedef void SoWinClipboardPasteCB(void *userData, SoPathList *pathList);
 
 
// The CLIPBOARD selection atom is not a predefined atom in X11 R4.
// However, it is widely recognized. We define it to 0 here for
// convenience. Internally, when SoWinClipboard sees _XA_CLIPBOARD_,
// it will use XInternAtom(d, "CLIPBOARD", False).
 
#define _XA_CLIPBOARD_ ((Atom) 0)
 
#define XA_STRING ((Atom) 1)
 
 
//
//  Class: SoWinClipboard
//
//      
 
class  SoWinClipboard {
 public:
  // Constructor.
  // The selection atom determines which X selection atom data transfers
  // should happen through. Default is _XA_CLIPBOARD_. (wsh uses XA_PRIMARY).
    
  SoWinClipboard(SoWidget w, Atom selectionAtom = _XA_CLIPBOARD_);
    
  ~SoWinClipboard();
 
  //
  // These methods transfer inventor scene graphs as the data.
  //
  // Data types supported for export (so another process can paste):
  //      INVENTOR, XA_STRING
  // (and someday: POSTSCRIPT, IMAGE)
  //
  // Data types supported for import (so this process can paste):
  //      INVENTOR, XA_STRING (pasted as an SoText2 node)
  //
 
  // Copy - these routines copy the passed data into a byte stream,
  // and make the data available to any X client which requests it.
  // The eventTime should be the time stamp from the event which
  // triggered the copy request.
    
  void    copy(SoNode *node, Time eventTime);
    
  void    copy(SoPath *path, Time eventTime);
 
  void    copy(SoPathList *pathList, Time eventTime);
 
  // Paste - make a request to the X server so we can import data for paste.
  // A paste is asynchronous - when this routine is called, it simply
  // makes a request to the X server for data to paste, then returns.
  // Once the data is delivered, the pasteDoneFunc will be called and passed
  // the user data along with a list of paths that were pasted. The app
  // should delete this path list when it is done with it.
  // The eventTime should be the time stamp from the event which
  // triggered the paste request.
    
  void    paste(Time eventTime,
                SoWinClipboardPasteCB *pasteDoneFunc,
                void *userData = NULL);
 
    private:
    static void exitClass();
    
 private:
  SoWidget      widget;         // the widget to associated data with
  Atom        selAtom;        // which selection: XA_PRIMARY, XA_SECONDARY, etc.
  Time        eventTime;      // time of the event which caused the copy/paste
    
  // Paste callback info
  SoWinClipboardPasteCB    *callbackFunc;
  void                    *userData;
    
  // Atoms supported for copy and paste targets:
  static Atom     TARGETSatom;  // XInternAtom(d, "TARGETS", False);
  static Atom INVENTORatom; // XInternAtom(d, "INVENTOR", False);
  //          XA_STRING
 
  static Atom *supportedTargets;
    
  // There can only be one owner of each X selection at any one time.
  // We use the selection atom as the key, and 'this' as the data.
  // We set the owner for each selection in this list for exportSelection.
  static SbDict   *selOwnerList;
    
  // Return the clipboard data in binary or ascii form.
  SoByteStream    *getBinaryBuffer();
  SoByteStream    *getAsciiBuffer();
    
  // All the overloaded copy functions call this one.
  void            copy(SoByteStream *byteStream, Time t);
 
 private:
  SoByteStream    *binaryBuffer;      // copy/paste storage buffer
  SoByteStream    *asciiBuffer;       // ascii version of storage buffer
    
  // Copy and paste callback functions - these are called by the X server.
  // importSelection is called when we import data to paste.
  // exportSelection is called when we send data for someone else to paste.
  // loseSelection is called when we no longer own the selection.
  static void         importSelection(
                                      SoWidget              w,
                                      SoWinClipboard      *clipboard,
                                      Atom                *selAtom,
                                      Atom                *type,
                                      char                *value,
                                      size_t      *length,
                                      int                 *format);
 
  static Boolean      exportSelection(
                                      SoWidget              w,
                                      Atom                *xselection,
                                      Atom                *target,
                                      Atom                *type,
                                      char                **value,
                                      size_t      *length,
                                      int                 *format);
 
  static void         loseSelection(
                                    SoWidget              w,
                                    Atom                *xselection);
                            
  static void         importSelectionTargets(
                                             SoWidget              w,
                                             SoWinClipboard      *clipboard,
                                             Atom                *selAtom,
                                             Atom                *type,
                                             char                *value,
                                             unsigned long       *length,
                                             int                 *format);
 
};
 
#include <Inventor/Win/SoWinEndStrict.h>
 
#endif /* _SO_WIN_CLIPBOARD_ */