#cp.config.textDroppedToDockIconCallback

Text Dropped to Dock Icon Callback


#API Overview

Methods - API calls which can only be made on an object returned by a constructor


#API Documentation

#Methods

Signaturecp.config.textDroppedToDockIconCallback:callbackFn() -> function
TypeMethod
DescriptionReturns the callbackFn of the current Text Dropped to Dock Icon Callback
Parameters
  • None
Returns
  • The callbackFn of the current Shutdown Callback
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/config/init.lua line 497

Signaturecp.config.textDroppedToDockIconCallback:get(id) -> table
TypeMethod
DescriptionCreates a new Text Dropped to Dock Icon Callback.
Parameters
  • id - The unique ID for the callback you want to return.
Returns
  • table containing the callback
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/config/init.lua line 458

Signaturecp.config.textDroppedToDockIconCallback:getAll() -> table
TypeMethod
DescriptionReturns all of the created Text Dropped to Dock Icon Callbacks
Parameters
  • None
Returns
  • table containing all of the created callbacks
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/config/init.lua line 471

Signaturecp.config.textDroppedToDockIconCallback:id() -> string
TypeMethod
DescriptionReturns the ID of the current Text Dropped to Dock Icon Callback
Parameters
  • None
Returns
  • The ID of the current Shutdown Callback as a string
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/config/init.lua line 484

Signaturecp.config.textDroppedToDockIconCallback:new(id, callbackFn) -> table
TypeMethod
DescriptionCreates a new Text Dropped to Dock Icon Callback.
Parameters
  • id - The unique ID for this callback.
  • callbackFn - The callback function
Returns
  • table that has been created
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/config/init.lua line 431