# 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

  • callbackFn
  • get
  • getAll
  • id
  • new

# API Documentation

# Methods

# callbackFn

Signature cp.config.textDroppedToDockIconCallback:callbackFn() -> function
Type Method
Description Returns the callbackFn of the current Text Dropped to Dock Icon Callback
Parameters
  • None
Returns
  • The callbackFn of the current Shutdown Callback
Notes None
Examples None
Source src/extensions/cp/config/init.lua line 497

# get

Signature cp.config.textDroppedToDockIconCallback:get(id) -> table
Type Method
Description Creates 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
Notes None
Examples None
Source src/extensions/cp/config/init.lua line 458

# getAll

Signature cp.config.textDroppedToDockIconCallback:getAll() -> table
Type Method
Description Returns all of the created Text Dropped to Dock Icon Callbacks
Parameters
  • None
Returns
  • table containing all of the created callbacks
Notes None
Examples None
Source src/extensions/cp/config/init.lua line 471

# id

Signature cp.config.textDroppedToDockIconCallback:id() -> string
Type Method
Description Returns the ID of the current Text Dropped to Dock Icon Callback
Parameters
  • None
Returns
  • The ID of the current Shutdown Callback as a string
Notes None
Examples None
Source src/extensions/cp/config/init.lua line 484

# new

Signature cp.config.textDroppedToDockIconCallback:new(id, callbackFn) -> table
Type Method
Description Creates 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
Notes None
Examples None
Source src/extensions/cp/config/init.lua line 431