Procedural File: designide.inc.php

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

addSplashBitmap [line 267]

void addSplashBitmap(
 $caption,  $bitmap)

Parameters

	$caption
	$bitmap

[ Top ]

registerAsset [line 106]

void registerAsset(
array $components, array $assets)

Registers an asset for the Deployment wizard, if your component needs extra folder(s) to be added for deployment, you can use this function to notify Deployment Wizard which folders do you want to get added

<?php
registerAsset(array("MainMenu","PopupMenu"),array("qooxdoo","dynapi"));
?>

Tags:

see:	registerComponents(), registerComponentEditor(), registerPropertyEditor()
link:	http://www.qadram.com/vcl4php/docwiki/index.php/Component_Writer%27s_Guide_::_Deployment

Parameters

array	$components	Array of components you want to register the asset
array	$assets	Array of folders you want to get copied when this component is used

[ Top ]

registerBooleanProperty [line 210]

void registerBooleanProperty(
string $classname, string $property)

Registers a boolean property, so the Object Inspector offers a true/false dropdown

<?php
registerBooleanProperty("Control","Visible");
?>

Tags:

see:

registerPropertyValues()

Parameters

string	$classname	Name of the component class for which register this property
string	$property	Property name

[ Top ]

registerComponentEditor [line 136]

void registerComponentEditor(
string $classname, string $componenteditorclassname, string $unitname)

Registers a component editor to be used by a component when right clicking on it

<?php
registerComponentEditor("Database","DatabaseEditor","designide.inc.php");
?>

Tags:

see:	registerComponents(), registerAsset(), registerPropertyEditor()
link:	http://www.qadram.com/vcl4php/docwiki/index.php/Component_Writer%27s_Guide_::_Component_Editors

Parameters

string	$classname	Name of the component class for which register this editor
string	$componenteditorclassname	Name of the class for the component editor
string	$unitname	Unit where the component editor resides

[ Top ]

registerComponents [line 68]

void registerComponents(
string $page, array $components, string $unit)

Registers components inside the IDE and places into the right palette page, it also allows the IDE to add the right unit to the source.

Using this function, you install a component inside the IDE and allows it to add the right unit to your source code using Code Insight.

Tags:

see:

registerAsset(), registerComponentEditor(), registerPropertyEditor()

Parameters

string	$page	Page where to put these components
array	$components	Array of component class names
string	$unit	Unit where to find these components

[ Top ]

registerDropDatafield [line 282]

void registerDropDatafield(
 $components)

Parameters

$components

[ Top ]

registerDropDatasource [line 273]

void registerDropDatasource(
 $components)

Parameters

$components

[ Top ]

registerNoVisibleComponents [line 257]

void registerNoVisibleComponents(
array $components, string $unit)

<?php
registerNoVisibleComponents(array("Page"),"forms.inc.php");
registerNoVisibleComponents(array("DataModule"),"forms.inc.php");
?>

Tags:

see:

registerComponents()

Parameters

array	$components	Array of component class names that are going to be no visible
string	$unit	Unit where to find those components

[ Top ]

registerPasswordProperty [line 236]

void registerPasswordProperty(
string $classname, string $property)

Registers a password property, so the Object Inspector doesn't show the value showing asterisks instead

<?php
registerPasswordProperty("CustomConnection","UserPassword");
?>

Parameters

string	$classname	Name of the component class for which register this property
string	$property	Name of the property to be password like

[ Top ]

registerPropertiesInCategory [line 78]

void registerPropertiesInCategory(
 $category,  $properties)

Parameters

	$category
	$properties

[ Top ]

registerPropertyEditor [line 160]

void registerPropertyEditor(
string $classname, string $property, string $propertyclassname, string $unitname)

Registers a property editor to edit an specific property

<?php
registerPropertyEditor("Control","Color","TSamplePropertyEditor","native");
?>

Tags:

see:	registerComponents(), registerAsset(), registerComponentEditor()
link:	http://www.qadram.com/vcl4php/docwiki/index.php/Component_Writer%27s_Guide_::_Property_Editors

Parameters

string	$classname	It can be an ancestor, property editors are also inherited
string	$property	Property Name
string	$propertyclassname	Property Editor class name
string	$unitname	Unit that holds the property editor class

[ Top ]

registerPropertyValues [line 186]

void registerPropertyValues(
string $classname, string $property, array $values)

Register values to be shown for a dropdown property, this function provides you a way to offer possibilities to the component user to setup a property

<?php
registerPropertyValues("DBPaginator","Orientation",array('noHorizontal','noVertical'));
registerPropertyValues("Datasource","DataSet",array('DataSet'));
?>

Tags:

see:	registerBooleanProperty()
link:	http://www.qadram.com/vcl4php/docwiki/index.php/Component_Writer%27s_Guide_::_Property_Editors

Parameters

string	$classname	Name of the class for which component we want to register these values
string	$property	Property name for which register this values
array	$values	Array of valid values will be shown in the Object Inspector

[ Top ]

setIconPath [line 50]

void setIconPath(
string $iconPath)

Specifies to the IDE the path to the icons for the components contained in this package (relative to the VCL path). Icons must be 16x16 bitmaps.

Tags:

see:

setPackageTitle()

Parameters

string

$iconPath

Path where to find icons for this package

[ Top ]

setPackageTitle [line 37]

void setPackageTitle(
string $packageTitle)

Specifies to the IDE the title of this package, use it on a package.php and set the parameter with the Title of the package to show on Component | Packages

Tags:

see:

setIconPath()

Parameters

string

$packageTitle

Title of the package to be shown on the IDE

[ Top ]

Documentation generated on Sat, 13 Jun 2009 10:51:29 -0700 by phpDocumentor 1.4.1