Client
[ class tree: Client ] [ index: Client ] [ all elements ]

Class: ToolProvider

Source Location: /client/ClientPlugin.php

Interface Overview


Interface for plugins with tools capability


Methods



Class Details

[line 108]
Interface for plugins with tools capability



[ Top ]


Class Methods


method getTools [line 139]

array getTools( )

Returns the provided tools

This method should always be called using PluginManager::callPluginImplementing.




Tags:

return:  array of ToolDescription
access:  public


[ Top ]

method handleApplicationTool [line 130]

void handleApplicationTool( ToolDescription $tool)

Handles tool when stateless application was clicked



Tags:

access:  public


Parameters:

ToolDescription   $tool   description of tool

[ Top ]

method handleKeymapTool [line 123]

void handleKeymapTool( ToolDescription $tool, Shape $keymapShape)

Handles tool when keymap was clicked



Tags:

access:  public


Parameters:

ToolDescription   $tool   description of tool
Shape   $keymapShape   selection on map

[ Top ]

method handleMainmapTool [line 115]

void handleMainmapTool( ToolDescription $tool, Shape $mainmapShape)

Handles tool when main map was clicked



Tags:

access:  public


Parameters:

ToolDescription   $tool   description of tool
Shape   $mainmapShape   selection on map

[ Top ]


Documentation generated on Mon, 09 Sep 2013 13:30:42 +0200 by phpDocumentor 1.3.0RC3