Class: PHPPowerPoint_Shape_RichText

Source Location: /PHPPowerpoint/Shape/RichText.php

Class Overview

PHPPowerPoint_Shape
   |
   --PHPPowerPoint_Shape_RichText

PHPPowerPoint_Shape_RichText

Author(s):

Copyright:

Implements interfaces:

PHPPowerPoint_IComparable

Inherited Variables

Class: PHPPowerPoint_Shape

PHPPowerPoint_Shape::$_fill
PHPPowerPoint_Shape::$_height
PHPPowerPoint_Shape::$_offsetX
PHPPowerPoint_Shape::$_offsetY
PHPPowerPoint_Shape::$_rotation
PHPPowerPoint_Shape::$_shadow
PHPPowerPoint_Shape::$_slide
PHPPowerPoint_Shape::$_width

Inherited Methods

Class: PHPPowerPoint_Shape

PHPPowerPoint_Shape::__construct(): Create a new PHPPowerPoint_Shape
PHPPowerPoint_Shape::getFill(): Get Fill
PHPPowerPoint_Shape::getHashCode(): Get hash code
PHPPowerPoint_Shape::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::getHeight(): Get Height
PHPPowerPoint_Shape::getOffsetX(): Get OffsetX
PHPPowerPoint_Shape::getOffsetY(): Get OffsetY
PHPPowerPoint_Shape::getRotation(): Get Rotation
PHPPowerPoint_Shape::getShadow(): Get Shadow
PHPPowerPoint_Shape::getSlide(): Get Slide
PHPPowerPoint_Shape::getWidth(): Get Width
PHPPowerPoint_Shape::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::setHeight(): Set Height
PHPPowerPoint_Shape::setOffsetX(): Set OffsetX
PHPPowerPoint_Shape::setOffsetY(): Set OffsetY
PHPPowerPoint_Shape::setRotation(): Set Rotation
PHPPowerPoint_Shape::setShadow(): Set Shadow
PHPPowerPoint_Shape::setSlide(): Set Slide
PHPPowerPoint_Shape::setWidth(): Set Width
PHPPowerPoint_Shape::setWidthAndHeight(): Set width and height with proportional resize
PHPPowerPoint_Shape::__clone(): Implement PHP __clone to create a deep clone, not just a shallow copy.

Class Details

[line 57]
PHPPowerPoint_Shape_RichText

PHPPowerPoint_Shape_RichText

Tags:

copyright:

[ Top ]

Class Variables

$_alignment =

[line 71]

Alignment

Tags:

access:

private

Type:

PHPPowerPoint_Style_Alignment

[ Top ]

$_hashIndex =

[line 223]

Hash index

Tags:

access:

private

Type:	string
Overrides:	Array

[ Top ]

$_richTextElements =

[line 64]

Rich text elements

Tags:

access:

private

Type:

PHPPowerPoint_Shape_RichText_ITextElement[]

[ Top ]

Class Methods

constructor __construct [line 76]

PHPPowerPoint_Shape_RichText __construct(
)

Create a new PHPPowerPoint_Shape_RichText instance

Tags:

access:

public

Overrides PHPPowerPoint_Shape::__construct() (Create a new PHPPowerPoint_Shape)

[ Top ]

method addText [line 102]

void addText(
[
$pText = null])

Add text

Tags:

throws:	Exception
access:	public

Parameters:

PHPPowerPoint_Shape_RichText_ITextElement

$pText

Rich text element

[ Top ]

method createBreak [line 127]

PHPPowerPoint_Shape_RichText_Break createBreak(
)

Create break

Tags:

throws:	Exception
access:	public

[ Top ]

method createText [line 114]

PHPPowerPoint_Shape_RichText_TextElement createText(
[string
$pText = ''])

Create text (can not be formatted !)

Tags:

throws:	Exception
access:	public

Parameters:

string

$pText

Text

[ Top ]

method createTextRun [line 141]

PHPPowerPoint_Shape_RichText_Run createTextRun(
[string
$pText = ''])

Create text run (can be formatted)

Tags:

throws:	Exception
access:	public

Parameters:

string

$pText

Text

[ Top ]

method getAlignment [line 91]

PHPPowerPoint_Style_Alignment getAlignment(
)

Get alignment

Tags:

access:

public

[ Top ]

method getHashCode [line 206]

string getHashCode(
)

Get hash code

Tags:

return:	Hash code
access:	public

Overrides PHPPowerPoint_Shape::getHashCode() (Get hash code)

[ Top ]

method getHashIndex [line 233]

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.

Tags:

return:	Hash index
access:	public

Overrides PHPPowerPoint_Shape::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 getPlainText [line 153]

string getPlainText(
)

Get plain text

Tags:

access:

public

[ Top ]

method getRichTextElements [line 181]

PHPPowerPoint_Shape_RichText_ITextElement[] getRichTextElements(
)

Get Rich Text elements

Tags:

access:

public

[ Top ]

method setHashIndex [line 245]

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.

Tags:

access:

public

Overrides PHPPowerPoint_Shape::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 setRichTextElements [line 192]

void setRichTextElements(
[PHPPowerPoint_Shape_RichText_ITextElement[]
$pElements = null])

Set Rich Text elements

Tags:

throws:	Exception
access:	public

Parameters:

PHPPowerPoint_Shape_RichText_ITextElement[]

$pElements

Array of elements

[ Top ]

method __clone [line 252]

void __clone(
)

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

Tags:

access:

public

Overrides PHPPowerPoint_Shape::__clone() (Implement PHP __clone to create a deep clone, not just a shallow copy.)

[ Top ]

method __toString [line 172]

string __toString(
)

Convert to string

Tags:

access:

public

[ Top ]

Documentation generated on Sat, 25 Apr 2009 11:37:52 +0200 by phpDocumentor 1.4.1