ClipboardProtocol

public protocol ClipboardProtocol : ObjectProtocol

The ClipboardProtocol protocol exposes the methods and properties of an underlying GtkClipboard instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see Clipboard. Alternatively, use ClipboardRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub

ptr
Untyped pointer to the underlying GtkClipboard instance.
Declaration
Swift

var ptr: UnsafeMutableRawPointer! { get }
Show on GitHub
clipboard_ptr Default implementation
Typed pointer to the underlying GtkClipboard instance.

Default Implementation

Return the stored, untyped pointer as a typed pointer to the GtkClipboard instance.
Declaration
Swift

var clipboard_ptr: UnsafeMutablePointer<GtkClipboard>! { get }
Show on GitHub
init(raw:)
Required Initialiser for types conforming to ClipboardProtocol
Declaration
Swift

init(raw: UnsafeMutableRawPointer)
Show on GitHub

Clipboard signals


                    
                    
                    connect(signal:flags:handler:)

Extension method

Connect a Swift signal handler to the given, typed ClipboardSignalName signal

Declaration

Swift

@discardableResult
@inlinable
func connect(signal s: ClipboardSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

Parameters

`signal`	The signal to connect
`flags`	The connection flags to use
`data`	A pointer to user data to provide to the callback
`destroyData`	A `GClosureNotify` C function to destroy the data pointed to by `userData`
`handler`	The Swift signal handler (function or callback) to invoke on the given signal

Return Value

The signal handler ID (always greater than 0 for successful connections)

Show on GitHub


                    
                    
                    connect(signal:flags:data:destroyData:signalHandler:)

Extension method

Connect a C signal handler to the given, typed ClipboardSignalName signal

Declaration

Swift

@discardableResult
@inlinable
func connect(signal s: ClipboardSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

Parameters

`signal`	The signal to connect
`flags`	The connection flags to use
`data`	A pointer to user data to provide to the callback
`destroyData`	A `GClosureNotify` C function to destroy the data pointed to by `userData`
`signalHandler`	The C function to be called on the given signal

Return Value

The signal handler ID (always greater than 0 for successful connections)

Show on GitHub


                    
                    
                    onOwnerChange(flags:handler:)

Extension method

Note

This represents the underlying owner-change signal

Declaration

Swift

@discardableResult
@inlinable
func onOwnerChange(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ClipboardRef, _ event: Gdk.EventOwnerChangeRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`event`	none
`handler`	The signal handler to call Run the given callback whenever the `ownerChange` signal is emitted

Show on GitHub

ownerChangeSignal Extension method
Typed owner-change signal for using the connect(signal:) methods
Declaration
Swift

static var ownerChangeSignal: ClipboardSignalName { get }
Show on GitHub

Clipboard Class: ClipboardProtocol extension (methods and fields)

clear() Extension method
Undocumented
Declaration
Swift

@inlinable func clear()
Show on GitHub
getDisplay() Extension method
Undocumented
Declaration
Swift

@inlinable func getDisplay() -> Gdk.DisplayRef!
Show on GitHub
getOwner() Extension method
Undocumented
Declaration
Swift

@inlinable func getOwner() -> GLibObject.ObjectRef!
Show on GitHub
getSelection() Extension method
Undocumented
Declaration
Swift

@inlinable func getSelection() -> GdkAtom!
Show on GitHub


                    
                    
                    requestContents(target:callback:userData:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func requestContents(target: GdkAtom, callback: GtkClipboardReceivedFunc?, userData: gpointer! = nil)

Show on GitHub


                    
                    
                    requestImage(callback:userData:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func requestImage(callback: GtkClipboardImageReceivedFunc?, userData: gpointer! = nil)

Show on GitHub


                    
                    
                    requestRichText(buffer:callback:userData:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func requestRichText<TextBufferT>(buffer: TextBufferT, callback: GtkClipboardRichTextReceivedFunc?, userData: gpointer! = nil) where TextBufferT : TextBufferProtocol

Show on GitHub


                    
                    
                    requestTargets(callback:userData:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func requestTargets(callback: GtkClipboardTargetsReceivedFunc?, userData: gpointer! = nil)

Show on GitHub


                    
                    
                    requestText(callback:userData:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func requestText(callback: GtkClipboardTextReceivedFunc?, userData: gpointer! = nil)

Show on GitHub


                    
                    
                    requestURIs(callback:userData:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func requestURIs(callback: GtkClipboardURIReceivedFunc?, userData: gpointer! = nil)

Show on GitHub


                    
                    
                    setCanStore(targets:nTargets:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func setCanStore(targets: UnsafePointer<GtkTargetEntry>! = nil, nTargets: Int)

Show on GitHub


                    
                    
                    setImage(pixbuf:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func setImage<PixbufT>(pixbuf: PixbufT) where PixbufT : PixbufProtocol

Show on GitHub

set(text:len:) Extension method
Undocumented
Declaration
Swift

@inlinable func set(text: UnsafePointer<gchar>!, len: Int)
Show on GitHub


                    
                    
                    setWithData(targets:nTargets:getFunc:clearFunc:userData:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func setWithData(targets: UnsafePointer<GtkTargetEntry>!, nTargets: Int, getFunc: GtkClipboardGetFunc?, clearFunc: GtkClipboardClearFunc?, userData: gpointer! = nil) -> Bool

Show on GitHub


                    
                    
                    setWithOwner(targets:nTargets:getFunc:clearFunc:owner:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func setWithOwner<ObjectT>(targets: UnsafePointer<GtkTargetEntry>!, nTargets: Int, getFunc: GtkClipboardGetFunc?, clearFunc: GtkClipboardClearFunc?, owner: ObjectT) -> Bool where ObjectT : ObjectProtocol

Show on GitHub

store() Extension method
Undocumented
Declaration
Swift

@inlinable func store()
Show on GitHub
waitForContents(target:) Extension method
Undocumented
Declaration
Swift

@inlinable func waitForContents(target: GdkAtom) -> SelectionDataRef!
Show on GitHub
waitForImage() Extension method
Undocumented
Declaration
Swift

@inlinable func waitForImage() -> PixbufRef!
Show on GitHub


                    
                    
                    waitForRichText(buffer:format:length:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func waitForRichText<TextBufferT>(buffer: TextBufferT, format: UnsafeMutablePointer<GdkAtom?>, length: UnsafeMutablePointer<gsize>!) -> UnsafeMutablePointer<guint8>? where TextBufferT : TextBufferProtocol

Show on GitHub

waitFor(targets:nTargets:) Extension method
Returns a list of targets that are present on the clipboard, or nil if there aren’t any targets available. The returned list must be freed with g_free(). This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait.
Declaration
Swift

@inlinable func waitFor(targets: UnsafeMutablePointer<UnsafeMutablePointer<GdkAtom?>?>!, nTargets: UnsafeMutablePointer<gint>!) -> Bool
Show on GitHub
waitForText() Extension method
Undocumented
Declaration
Swift

@inlinable func waitForText() -> String!
Show on GitHub


                    
                    
                    waitForURIs()

Extension method

Undocumented

Declaration

Swift

@inlinable
func waitForURIs() -> UnsafeMutablePointer<UnsafeMutablePointer<gchar>?>!

Show on GitHub

waitIsImageAvailable() Extension method
Undocumented
Declaration
Swift

@inlinable func waitIsImageAvailable() -> Bool
Show on GitHub


                    
                    
                    waitIsRichTextAvailable(buffer:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func waitIsRichTextAvailable<TextBufferT>(buffer: TextBufferT) -> Bool where TextBufferT : TextBufferProtocol

Show on GitHub

waitIsTargetAvailable(target:) Extension method
Undocumented
Declaration
Swift

@inlinable func waitIsTargetAvailable(target: GdkAtom) -> Bool
Show on GitHub
waitIsTextAvailable() Extension method
Undocumented
Declaration
Swift

@inlinable func waitIsTextAvailable() -> Bool
Show on GitHub
waitIsURIsAvailable() Extension method
Undocumented
Declaration
Swift

@inlinable func waitIsURIsAvailable() -> Bool
Show on GitHub
display Extension method
Undocumented
Declaration
Swift

@inlinable var display: Gdk.DisplayRef! { get }
Show on GitHub
owner Extension method
Undocumented
Declaration
Swift

@inlinable var owner: GLibObject.ObjectRef! { get }
Show on GitHub
selection Extension method
Undocumented
Declaration
Swift

@inlinable var selection: GdkAtom! { get }
Show on GitHub

ClipboardProtocol

Declaration

Default Implementation

Declaration

Declaration

Clipboard signals

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Declaration

Clipboard Class: ClipboardProtocol extension (methods and fields)

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration