Script updates

[wxWidgets.git] / wxPython / src / _clipbrd.i

/////////////////////////////////////////////////////////////////////////////
// Name:        _clipbrd.i
// Purpose:     SWIG definitions for the Clipboard
//
// Author:      Robin Dunn
//
// Created:     31-October-1999
// RCS-ID:      $Id$
// Copyright:   (c) 2003 by Total Control Software
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

// Not a %module


//---------------------------------------------------------------------------
%newgroup

%{
%}

DocStr(wxClipboard,
       
"wx.Clipboard represents the system clipboard and provides methods to copy data
to or paste data from it.  Normally, you should only use wx.TheClipboard which
is a reference to a global wx.Clipboard instance.

Call wx.TheClipboard.Open to get ownership of the clipboard. If this operation
returns True, you now own the clipboard. Call wx.TheClipboard.SetData to put
data on the clipboard, or wx.TheClipboard.GetData to retrieve data from the
clipboard.  Call wx.TheClipboard.Close to close the clipboard and relinquish
ownership. You should keep the clipboard open only momentarily.
");



class wxClipboard : public wxObject {
public:
    DocCtorStr( wxClipboard(), "" );
    
    ~wxClipboard();


    DocDeclStr(
        virtual bool , Open(),
        "Call this function to open the clipboard before calling SetData\n"
        "and GetData.  Call Close when you have finished with the clipboard.\n"
        "You should keep the clipboard open for only a very short time.\n"
        "Returns true on success. ");
    

    DocDeclStr(
        virtual void , Close(),
        "Closes the clipboard.");
    

    DocDeclStr(
        virtual bool , IsOpened() const,
        "Query whether the clipboard is opened");
    


    %apply SWIGTYPE *DISOWN { wxDataObject *data };
    
    DocDeclStr(
        virtual bool , AddData( wxDataObject *data ),
        "Call this function to add the data object to the clipboard. You\n"
        "may call this function repeatedly after having cleared the clipboard.\n"
        "After this function has been called, the clipboard owns the data, so\n"
        "do not delete the data explicitly.");
    

    DocDeclStr(
        virtual bool , SetData( wxDataObject *data ),
        "Set the clipboard data, this is the same as Clear followed by AddData.");
    

    %clear wxDataObject *data;
    

    DocDeclStr(
        virtual bool , IsSupported( const wxDataFormat& format ),
        "Returns True if the given format is available in the data object(s) on\n"
        "the clipboard.");

    DocDeclStr(
        virtual bool , GetData( wxDataObject& data ),
        "Call this function to fill data with data on the clipboard, if available\n"
        "in the required format. Returns true on success.");
    
    
    DocDeclStr(
        virtual void , Clear(),
        "Clears data from the clipboard object and also  the system's clipboard\n"
        "if possible.");
    

    DocDeclStr(
        virtual bool , Flush(),
        "Flushes the clipboard: this means that the data which is currently on\n"
        "clipboard will stay available even after the application exits (possibly\n"
        "eating memory), otherwise the clipboard will be emptied on exit.\n"
        "Returns False if the operation is unsuccesful for any reason.");
    

    DocDeclStr(
        virtual void , UsePrimarySelection( bool primary = True ),
        "On platforms supporting it (the X11 based platforms), selects the so\n"
        "called PRIMARY SELECTION as the clipboard as opposed to the normal\n"
        "clipboard, if primary is True.");
};


%immutable;
wxClipboard* const wxTheClipboard;
%mutable;



//---------------------------------------------------------------------------


DocStr(wxClipboardLocker,
"A helpful class for opening the clipboard and automatically closing it when
the locker is destroyed.");

class wxClipboardLocker
{
public:
    wxClipboardLocker(wxClipboard *clipboard = NULL);
    ~wxClipboardLocker();

    DocStr(__nonzero__,
           "A ClipboardLocker instance evaluates to True if the clipboard was\n"
           "successfully opened.")
    %extend {
        bool __nonzero__()   { return !!(*self); }
    }
};


//---------------------------------------------------------------------------