Client
[ class tree: Client ] [ index: Client ] [ all elements ]
Packages:
Client
Common
CorePlugins
Plugins
Scripts
Server
Tests


Files:
Cartoclient.php
CartoserverService.php
ClientMapInfoCache.php
ClientPlugin.php
ClientPluginHelper.php
ClientProjectHandler.php
ExportPlugin.php
FormRenderer.php
HttpRequestHandler.php
Internationalization.php
MapInfoCache.php
ServerMapInfoCache.php
Smarty_Cartoclient.php

Classes:
Cartoclient
CartoclientException
CartoForm
CartoserverService
ClientConfig
ClientMapInfoCache
ClientPlugin
ClientPluginConfig
ClientPluginHelper
ClientProjectHandler
ClientSession
DhtmlSelectionParser
EncoderInterface
EncoderISO
EncoderUTF
Exportable
ExportConfiguration
ExportOutput
ExportPlugin
FilterProvider
FilterRequestModifier
FormRenderer
GuiProvider
HttpRequestHandler
I18n
I18nDummy
I18nGettext
I18nInterface
InitUser
InitUserHelper
JsToolAttributes
PixelCoordsConverter
ServerCaller
ServerCallerHelper
Sessionable
SessionableHelper
Smarty_Cartoclient
Smarty_CorePlugin
ToolDescription
ToolProvider
ToolProviderHelper

Class: ToolDescription

Source Location: /client/ClientPlugin.php

Class Overview




Description of a tool














Variables






Constants






Methods
























Class Details



[line 126]

Description of a tool





[ Top ]







Class Variables



	
	

	
$appliesTo = 

	
[line 162]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$hasIcon = 

	
[line 142]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$id = 

	
[line 137]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$jsAttributes = 

	
[line 147]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      JsToolAttributes
    

      

	



	
[ Top ]


	
	

	
$plugin = 

	
[line 157]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$weight = 

	
[line 152]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 173]

	

    

    

		ToolDescription __construct(
string
$id, boolean
$hasIcon, JsToolAttributes
$jsAttributes, int
$weight, [boolean
$plugin = false], [int
$appliesTo = self::MAINMAP])
    

    


	
		Constructor





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $id  
        
      

          

        boolean  
        $hasIcon  
        
      

          

        JsToolAttributes  
        $jsAttributes  
        
      

          

        int  
        $weight  
        
      

          

        boolean  
        $plugin  
        
      

          

        int  
        $appliesTo  
        
      

        

    


        
[ Top ]

  









Class Constants



	
	

	
KEYMAP =  4

	
[line 132]

  
  

	
[ Top ]


	
	

	
MAINMAP =  2

	
[line 131]

  Bitmask for tools


  

	
[ Top ]






        

		    

		    Documentation generated on Wed,  6 Apr 2005 12:06:34 +0200 by phpDocumentor 1.3.0RC3