PHPPowerPoint_Shape
[ class tree: PHPPowerPoint_Shape ] [ index: PHPPowerPoint_Shape ] [ all elements ]
Packages:
PHPPowerPoint
PHPPowerPoint_Reader
PHPPowerPoint_RichText
PHPPowerPoint_Shape
PHPPowerPoint_Shared
PHPPowerPoint_Slide
PHPPowerPoint_Style
PHPPowerPoint_Writer
PHPPowerPoint_Writer_PowerPoint2007


Files:
BaseDrawing.php
Drawing.php
ITextElement.php
MemoryDrawing.php
RichText.php
Run.php
Shadow.php
Shape.php

Interfaces:
PHPPowerPoint_Shape_RichText_ITextElement
Classes:
PHPPowerPoint_Shape
PHPPowerPoint_Shape_BaseDrawing
PHPPowerPoint_Shape_Drawing
PHPPowerPoint_Shape_MemoryDrawing
PHPPowerPoint_Shape_RichText_Break
PHPPowerPoint_Shape_RichText_Run
PHPPowerPoint_Shape_RichText_TextElement
PHPPowerPoint_Shape_Shadow

Class: PHPPowerPoint_Shape

Source Location: /PHPPowerpoint/Shape.php

Class Overview




PHPPowerPoint_Shape




Author(s):


    
              





      
      


Copyright:


    
  
  • Copyright (c) 2009 - 2010 PHPPowerPoint (http://www.codeplex.com/PHPPowerPoint)
    • 


                

            Implements interfaces:
            

        

        




Variables







Methods















Child classes:






PHPPowerPoint_Shape_BaseDrawing

	
PHPPowerPoint_Shape_BaseDrawing






PHPPowerPoint_Shape_RichText

	
PHPPowerPoint_Shape_RichText

















Class Details



[line 49]

PHPPowerPoint_Shape

PHPPowerPoint_Shape





Tags:





  

    copyright:  Copyright (c) 2009 - 2010 PHPPowerPoint (http://www.codeplex.com/PHPPowerPoint)
  

  

    abstract:  
  










[ Top ]







Class Variables



	
	

	
$_fill = 

	
[line 91]

  Fill

Fill





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPPowerPoint_Style_Fill
    

      

	



	
[ Top ]


	
	

	
$_hashIndex = 

	
[line 319]

  Hash index

Hash index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_height = 

	
[line 84]

  Height

Height





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_offsetX = 

	
[line 63]

  Offset X

Offset X





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_offsetY = 

	
[line 70]

  Offset Y

Offset Y





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_rotation = 

	
[line 98]

  Rotation

Rotation





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_shadow = 

	
[line 105]

  Shadow

Shadow





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      PHPPowerPoint_Shape_Shadow
    

      

	



	
[ Top ]


	
	

	
$_slide = 

	
[line 56]

  Slide

Slide





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      PHPPowerPoint_Slide
    

      

	



	
[ Top ]


	
	

	
$_width = 

	
[line 77]

  Width

Width





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 110]

	

    

    

		PHPPowerPoint_Shape __construct(
)
    

    


	
		Create a new PHPPowerPoint_Shape

Create a new PHPPowerPoint_Shape





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPPowerPoint_Shape_BaseDrawing::__construct()

		
Create a new PHPPowerPoint_Slide_BaseDrawing

	

		

	
PHPPowerPoint_Shape_Drawing::__construct()

		
Create a new PHPPowerPoint_Slide_Drawing

	

		

	
PHPPowerPoint_Shape_MemoryDrawing::__construct()

		
Create a new PHPPowerPoint_Slide_MemoryDrawing

	

		

	
PHPPowerPoint_Shape_RichText::__construct()

		
Create a new PHPPowerPoint_Shape_RichText instance

	

	

	
        
[ Top ]

  

  

	
	
method getFill [line 272]

	

    

    

		PHPPowerPoint_Style_Fill getFill(
)
    

    


	
		Get Fill

Get Fill





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 300]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPPowerPoint_Shape_BaseDrawing::getHashCode()

		
Get hash code

	

		

	
PHPPowerPoint_Shape_Drawing::getHashCode()

		
Get hash code

	

		

	
PHPPowerPoint_Shape_MemoryDrawing::getHashCode()

		
Get hash code

	

		

	
PHPPowerPoint_Shape_RichText::getHashCode()

		
Get hash code

	

	

	
        
[ Top ]

  

  

	
	
method getHashIndex [line 329]

	

    

    

		string getHashIndex(
)
    

    


	
		Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    return:  Hash index
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPPowerPoint_Shape_BaseDrawing::getHashIndex()

		
Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

		

	
PHPPowerPoint_Shape_Drawing::getHashIndex()

		
Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

		

	
PHPPowerPoint_Shape_MemoryDrawing::getHashIndex()

		
Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

		

	
PHPPowerPoint_Shape_RichText::getHashIndex()

		
Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

	

	
        
[ Top ]

  

  

	
	
method getHeight [line 224]

	

    

    

		int getHeight(
)
    

    


	
		Get Height

Get Height





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getOffsetX [line 170]

	

    

    

		int getOffsetX(
)
    

    


	
		Get OffsetX

Get OffsetX





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getOffsetY [line 188]

	

    

    

		int getOffsetY(
)
    

    


	
		Get OffsetY

Get OffsetY





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRotation [line 254]

	

    

    

		int getRotation(
)
    

    


	
		Get Rotation

Get Rotation





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getShadow [line 281]

	

    

    

		PHPPowerPoint_Shape_Shadow getShadow(
)
    

    


	
		Get Shadow

Get Shadow





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSlide [line 128]

	

    

    

		PHPPowerPoint_Slide getSlide(
)
    

    


	
		Get Slide

Get Slide





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getWidth [line 206]

	

    

    

		int getWidth(
)
    

    


	
		Get Width

Get Width





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setHashIndex [line 341]

	

    

    

		void setHashIndex(
string
$value)
    

    


	
		Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPPowerPoint_Shape_BaseDrawing::setHashIndex()

		
Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

		

	
PHPPowerPoint_Shape_Drawing::setHashIndex()

		
Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

		

	
PHPPowerPoint_Shape_MemoryDrawing::setHashIndex()

		
Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

		

	
PHPPowerPoint_Shape_RichText::setHashIndex()

		
Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

	

	
        
Parameters:

    

    

          

        string  
        $value  
        Hash index
      

        

    


        
[ Top ]

  

  

	
	
method setHeight [line 233]

	

    

    

		void setHeight(
[int
$pValue = 0])
    

    


	
		Set Height

Set Height





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPPowerPoint_Shape_BaseDrawing::setHeight()

		
Set Height

	

	

	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setOffsetX [line 179]

	

    

    

		void setOffsetX(
[int
$pValue = 0])
    

    


	
		Set OffsetX

Set OffsetX





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setOffsetY [line 197]

	

    

    

		void setOffsetY(
[int
$pValue = 0])
    

    


	
		Set OffsetY

Set OffsetY





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setRotation [line 263]

	

    

    

		void setRotation(
[int
$pValue = 0])
    

    


	
		Set Rotation

Set Rotation





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setShadow [line 291]

	

    

    

		void setShadow(
[PHPPowerPoint_Shape_Shadow
$pValue = null])
    

    


	
		Set Shadow

Set Shadow





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPPowerPoint_Shape_Shadow  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setSlide [line 139]

	

    

    

		void setSlide(
[
$pValue = null], [bool
$pOverrideOld = false])
    

    


	
		Set Slide

Set Slide





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPPowerPoint_Slide  
        $pValue  
        
      

          

        bool  
        $pOverrideOld  
        If a Slide has already been assigned, overwrite it and remove image from old Slide?
      

        

    


        
[ Top ]

  

  

	
	
method setWidth [line 215]

	

    

    

		void setWidth(
[int
$pValue = 0])
    

    


	
		Set Width

Set Width





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPPowerPoint_Shape_BaseDrawing::setWidth()

		
Set Width

	

	

	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setWidthAndHeight [line 244]

	

    

    

		void setWidthAndHeight(
[int
$width = 0], [int
$height = 0])
    

    


	
		Set width and height with proportional resize

Set width and height with proportional resize





Tags:





  

    access:  public
  

  

    example:  example not found
  









	
Overridden in child classes as:

		

	
PHPPowerPoint_Shape_BaseDrawing::setWidthAndHeight()

		
Set width and height with proportional resize

	

	

	
        
Parameters:

    

    

          

        int  
        $width  
        
      

          

        int  
        $height  
        
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 348]

	

    

    

		void __clone(
)
    

    


	
		Implement PHP __clone to create a deep clone, not just a shallow copy.

Implement PHP __clone to create a deep clone, not just a shallow copy.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPPowerPoint_Shape_BaseDrawing::__clone()

		
Implement PHP __clone to create a deep clone, not just a shallow copy.

	

		

	
PHPPowerPoint_Shape_Drawing::__clone()

		
Implement PHP __clone to create a deep clone, not just a shallow copy.

	

		

	
PHPPowerPoint_Shape_MemoryDrawing::__clone()

		
Implement PHP __clone to create a deep clone, not just a shallow copy.

	

		

	
PHPPowerPoint_Shape_RichText::__clone()

		
Implement PHP __clone to create a deep clone, not just a shallow copy.

	

	

	
        
[ Top ]

  






        

		    

		    Documentation generated on Sat, 25 Apr 2009 11:38:03 +0200 by phpDocumentor 1.4.1