From 6b3d681ece7a20b40ed00cccffefb8b144ffdd81 Mon Sep 17 00:00:00 2001 From: DarkWyrm Date: Sat, 2 Nov 2002 23:46:01 +0000 Subject: [PATCH] Checkin for Gabe Yoder git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1827 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- .../app/usecases/BClipboardUseCases.html | 7 +- docs/develop/servers/registrar/Protocols | 135 ++++++++++++++++++ 2 files changed, 139 insertions(+), 3 deletions(-) diff --git a/docs/develop/app/usecases/BClipboardUseCases.html b/docs/develop/app/usecases/BClipboardUseCases.html index 1be0580386..2273283e39 100644 --- a/docs/develop/app/usecases/BClipboardUseCases.html +++ b/docs/develop/app/usecases/BClipboardUseCases.html @@ -143,11 +143,12 @@ changed, a B_CLIPBOARD_CHANGED message is sent to the target specified in the ca

BClipboard Implementation:

-The BClipboard class is implemented via a message passing system between the BClipboard, the Roster, and -the Clipboard Handler associated with the Roster. Details of the message passing protocol are listed in the -Roster documentation. +The BClipboard class is implemented via a message passing system between the BClipboard, the Registrar, and +the Clipboard Handler associated with the Registrar. Details of the message passing protocol are listed in the +Registrar documentation.

+ diff --git a/docs/develop/servers/registrar/Protocols b/docs/develop/servers/registrar/Protocols index 3b0343820c..189ae2fd31 100644 --- a/docs/develop/servers/registrar/Protocols +++ b/docs/develop/servers/registrar/Protocols @@ -731,3 +731,138 @@ error reply fields: ----------------------------------------------------------------------- + +Clipboard Handler Requests +-------------------------- + +add new clipboard to system (BClipboard::BClipboard()) + +target: clipboard handler +message: B_REG_ADD_CLIPBOARD + "name": B_STRING_TYPE +reply: standard general result + +message fields: +- "name": Name used to identify the particular clipboard to add + +reply fields: +- "result": + - B_OK: B + - B_BAD_VALUE: name field was not specified in message + +----------------------------------------------------------------------- + +get clipboard write count (BClipboard::GetSystemCount()) + +target: clipboard handler +message: B_REG_GET_CLIPBOARD_COUNT + "name": B_STRING_TYPE +reply: standard general result + "count": B_INT32_TYPE + +message fields: +- "name": Name used to identify the particular clipboard + +reply fields: +- "result": + - B_OK: success + - B_BAD_VALUE: no name / no valid name specified in message +- "count": + - number of times this clipboard has been written to + +----------------------------------------------------------------------- + +start watching clipboard (BClipboard::StartWatching()) + +target: clipboard handler +message: B_REG_CLIPBOARD_START_WATCHING + "name": B_STRING_TYPE + "target": B_MESSENGER_TYPE +reply: standard general result + +message fields: +- "name": Name used to identify the particular clipboard +- "target": Messenger pointing to the target to notify + +reply fields: +- "result": + - B_OK: success + - B_BAD_VALUE: no name / no valid name specified in message + no target specified + +----------------------------------------------------------------------- + +stop watching clipboard (BClipboard::StopWatching()) + +target: clipboard handler +message: B_REG_CLIPBOARD_STOP_WATCHING + "name": B_STRING_TYPE + "target": B_MESSENGER_TYPE +reply: standard general result + +message fields: +- "name": Name used to identify the particular clipboard +- "target": Messenger pointing to the target to remove from the notify list + +reply fields: +- "result": + - B_OK: success + - B_BAD_VALUE: no name / no valid name specified in message + no target specified + +----------------------------------------------------------------------- + +download clipboard data (BClipboard::DownloadFromSystem()) + +target: clipboard handler +message: B_REG_DOWNLOAD_CLIPBOARD + "name": B_STRING_TYPE +reply: standard general result + "data": B_MESSAGE_TYPE + "data source": B_MESSENGER_TYPE + "count": B_INT32_TYPE + +message fields: +- "name": Name used to identify the particular clipboard + +reply fields: +- "result": + - B_OK: success + - B_BAD_VALUE: no name / no valid name specified in message + no target specified +- "data": + - message with Data fields containing the contents of the clipboard +- "data source": + - messenger to the be_app_messenger of the application which last wrote data +- "count": + - number of times this clipboard has been written to + +----------------------------------------------------------------------- + +upload clipboard data (BClipboard::UploadToSystem()) + +target: clipboard handler +message: B_REG_UPLOAD_CLIPBOARD + "name": B_STRING_TYPE + "data": B_MESSAGE_TYPE + "data source": B_MESSENGER_TYPE +reply: standard general result + "count": B_INT32_TYPE + +message fields: +- "name": Name used to identify the particular clipboard +- "data": + - message with Data fields containing the contents of the clipboard +- "data source": + - messenger to the be_app_messenger of the application which last wrote data + +reply fields: +- "result": + - B_OK: success + - B_BAD_VALUE: no name / no valid name specified in message + no target specified +- "count": + - number of times this clipboard has been written to + +----------------------------------------------------------------------- +