Overview

Packages

  • Actions
  • Codegen
  • Controls
    • Base
  • DatabaseAdapters
  • Events
  • None
  • Sessions
  • Tests

Classes

  • BasicForm
  • CalculatorWidget
  • DataRepeaterExample
  • ExampleCheckColumn1
  • ExampleCheckColumn2
  • ExampleSingleForm
  • NestedTabForm
  • PaginatorForm
  • ParamsForm
  • PersistentExampleForm
  • PersonEditPanel
  • PluginEditForm
  • PluginManagerForm
  • ProjectEditPanel
  • ProjectListForm
  • ProjectViewPanel
  • QAccordion
  • QActionControl
  • QAutocomplete
  • QBlockControl
  • QButton
  • QButtonBase
  • QCalendar
  • QCheckBox
  • QCheckBoxLegacyColumn
  • QCheckBoxList
  • QControl
  • QControlBase
  • QControlGrouping
  • QControlLabel
  • QCsvTextBox
  • QDataGrid
  • QDataGrid_CheckBoxColumn
  • QDataGrid_SortEvent
  • QDataGridBase
  • QDataGridLegacy
  • QDataGridLegacyBase
  • QDataGridLegacyColumn
  • QDataGridLegacyRow
  • QDataGridLegacyRowStyle
  • QDataRepeater
  • QDatepicker
  • QDatepickerBox
  • QDateTimePicker
  • QDateTimeTextBox
  • QDialog
  • QDialogBox
  • QDraggable
  • QDroppable
  • QDropZoneGrouping
  • QEmailTextBox
  • QFileAsset
  • QFileAssetBase
  • QFileAssetDialog
  • QFileControl
  • QFilterType
  • QFloatTextBox
  • QFontFamily
  • QForm
  • QFormBase
  • QHListItem
  • QHtmlAttributeManager
  • QHtmlAttributeManagerBase
  • QHtmlTable
  • QHtmlTableBase
  • QImageBase
  • QImageBrowser
  • QImageBrowserBase
  • QImageBrowserNav
  • QImageBrowserThumbnails
  • QImageButton
  • QImageControl
  • QImageControlBase
  • QImageFileAsset
  • QImageLabel
  • QImageLabelBase
  • QImageRollover
  • QIntegerTextBox
  • QJqButton
  • QJqCheckBox
  • QJqRadioButton
  • QJsTimer
  • QJsTimerBase
  • QLabel
  • QLinkButton
  • QListBox
  • QListBoxBase
  • QListControl
  • QListItem
  • QListItemBase
  • QListItemStyle
  • QNumericTextBox
  • QPaginatedControl
  • QPaginator
  • QPaginatorBase
  • QPanel
  • QProgressbar
  • QRadioButton
  • QRadioButtonList
  • QResizable
  • QSampleControl
  • QSelectable
  • QSlider
  • QSortable
  • QTabs
  • QTagStyler
  • QTestControl
  • QTextBox
  • QTimerExpiredEvent
  • QTreeNav
  • QTreeNavItem
  • QUrlTextBox
  • QWaitIcon
  • QWriteBox
  • RecordsSummary
  • RefreshForm
  • SampleForm
  • SelectableLabel
  • SpeedForm
  • TestImageBrowser
  • UrlForm

Traits

  • QListItemManager

Exceptions

  • QCrossScriptingException

Functions

  • __QForm_EvaluateTemplate_ObHandler
  • DataGridEvalHandleError
  • Overview
  • Package
  • Class

Package Controls

Packages summary
Controls\Base
for a DataGrid
Classes summary
BasicForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
CalculatorWidget Implements a JQuery UI Dialog
DataRepeaterExample QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
ExampleCheckColumn1

A checkbox column that specifically is for inclusion in a QDataGrid object. The two work together to hand off important events and functionality.

ExampleCheckColumn2

A checkbox column that specifically is for inclusion in a QDataGrid object. The two work together to hand off important events and functionality.

ExampleSingleForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
NestedTabForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
PaginatorForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
ParamsForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
PersistentExampleForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
PersonEditPanel

The QPanel Class is defined here. QPanel class can be used to create composite controls which are to be rendered as blocks (not inline)

PluginEditForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
PluginManagerForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
ProjectEditPanel

The QPanel Class is defined here. QPanel class can be used to create composite controls which are to be rendered as blocks (not inline)

ProjectListForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
ProjectViewPanel

The QPanel Class is defined here. QPanel class can be used to create composite controls which are to be rendered as blocks (not inline)

QAccordion Creates the jQuery Accordian control
QActionControl

Abstract class which is extended by things like Buttons. It basically pre-sets CausesValidation to be true (b/c most of the time, when a button is clicked we'd assume that we want the validation to kick off) And it pre-defines ParsePostData and Validate.

QAutocomplete This class only extends QAutocompleteBase which implements the actual functionality.
QBlockControl

This abstract class is designed to be a base for class for span and div controls. It adds additional drag and drop support to these objects, as well as templating.

QButton

QButton class - You may modify it to contain your own modifications to the QButton throughout the framework.

QButtonBase This class will render an HTML Button.
QCalendar

This class will render a pop-up, modeless calendar control that can be used to let the user pick a date.

QCheckBox This class will render an HTML Checkbox.
QCheckBoxLegacyColumn

This defines a specific column

for a DataGrid All the appearance properties should be self-explanatory. The SortByCommand and ReverseSortByCommand are both optional -- and are explained in more depth in DataGrid.inc

QCheckBoxList

This class will render a List of HTML Checkboxes (inhereting from ListControl). By definition, checkbox lists are multiple-select ListControls.

QControl QControl is the user overridable Base-Class for all Controls.
QControlBase QControlBase is the base class of all QControls and shares their common properties.
QControlGrouping
QControlLabel This class will render a 'label' HTML element
QCsvTextBox

A subclass of TextBox that allows the user to type in a list of values to be converted into an array. Uses str_getcsv to process.

QDataGrid

QDataGrid can help generate tables automatically with pagination. It can also be used to render data directly from database by using a 'DataSource'. The code-generated search pages you get for every table in your database are all QDataGrids

QDataGrid_CheckBoxColumn

A checkbox column that specifically is for inclusion in a QDataGrid object. The two work together to hand off important events and functionality.

QDataGrid_SortEvent

Base class of QEvents. Events are used in conjunction with actions to respond to user actions, like clicking, typing, etc., or even programmable timer events.

QDataGridBase Class QDataGridBase
QDataGridLegacy

QDataGridLegacy can help generate tables automatically with pagination. It can also be used to render data directly from database by using a 'DataSource'. The code-generated search pages you get for every table in your database are all QDataGrids.

QDataGridLegacyBase

NOTE: Due to the use of "Eval" and HTML4 specific tags, this class is now deprecated and the name has been changed from QDataGrid to QDataGridLegacy.

QDataGridLegacyColumn

This defines a specific column

for a DataGrid All the appearance properties should be self-explanatory. The SortByCommand and ReverseSortByCommand are both optional -- and are explained in more depth in DataGrid.inc

QDataGridLegacyRow
QDataGridLegacyRowStyle This defines a style for a row
QDataRepeater

The QDataRepeater is a generic html base object for creating an object that contains a list of items tied to the database. To specify how to draw the items, you can either create a template file, override the GetItemHtml method, override the GetItemInnerHtml and GetItemAttributes methods, or specify corresponding callbacks for those methods.

QDatepicker Creates the jQuery Datepicker control
QDatepickerBox Creates the jQuery Datepicker control (with a textbox)
QDateTimePicker

This class is meant to be a date-picker. It will essentially render an uneditable HTML textbox as well as a calendar icon. The idea is that if you click on the icon or the textbox, it will pop up a calendar in a new small window.

QDateTimeTextBox
QDialog Implements a JQuery UI Dialog
QDialogBox
QDraggable
QDroppable
QDropZoneGrouping This file contains the QDropZoneGrouping class.
QEmailTextBox A subclass of TextBox that validates and sanitizes emails.
QFileAsset QFileAsset
QFileAssetBase
QFileAssetDialog This file contains the QFileAssetDialog class.
QFileControl This class will render an HTML File input.
QFilterType Class QFilterType: Type of filter which can be implemented on a QDataGridLegacy's Column
QFloatTextBox

A subclass of QNumericTextBox -- Validate will also ensure that the Text is a valid float and (if applicable) is in the range of Minimum <= x <= Maximum

QFontFamily

QFontFamily class is an abstract class which arranges the commonly used font families the the main font in the family

QForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
QFormBase
QHListItem

Represents an item in a hierarchical item list. Uses the QListItemManager trait to manage the interface for adding sub-items.

QHtmlAttributeManager QHtmlAttributeManager
QHtmlAttributeManagerBase

A base class for objects that manage html attributes. Uses array functions and defines a couple of arrays to manage the attributes. Values will be html escaped when printed.

QHtmlTable
QHtmlTableBase

<

p>This control is used to display a simple html table.

QImageBase
QImageBrowser

A simple implementation of the QImageBrowserBase, which takes the images from a provided array of image paths (must be absolute paths). It has a method that you can use to load all the images from a directory. By default it aassumes that the captions are saved in the same directory in files with an additional ".txt" extension.

QImageBrowserBase
QImageBrowserNav Control for a simple image browser.
QImageBrowserThumbnails
QImageButton This class will render an HTML ImageButton .
QImageControl
QImageControlBase This class will render an Image Control of any image file in the system
QImageFileAsset ImageFileAsset is derived from QFileAsset and is a dedicated control for uploading images (images only).
QImageLabel
QImageLabelBase This class will render an Image/Bitmapped version of any Text string
QImageRollover
QIntegerTextBox

A subclass of TextBox with its validate method overridden -- Validate will also ensure that the Text is a valid integer and (if applicable) is in the range of Minimum <= x <= Maximum

QJqButton
QJqCheckBox This class mplements a JQuery Ui Check Box.
QJqRadioButton Implements a JQuery UI Radio Button
QJsTimer The QJsTimer class (and related classes) reside here.
QJsTimerBase

Timer Control: This control uses a javascript timer to execute Actions after a defined time Periodic or one shot timers are possible. You can add only one type of Event to to this control: QTimerExpiredEvent but multiple actions can be registered for this event

QLabel

QLabel class is used to create text on the client side. By default it will not accept raw HTML for text. Set Htmlentities to false to enable that behavior

QLinkButton

This class will render an HTML link , but will act like a Button or ImageButton. (it is a subclass of actioncontrol) Therefore, you cannot define a "URL/HREF" destination for this LinkButton. It simply links to "#". And then if a ClientAction is defined, it will execute that when clicked. If a ServerAction is defined, it will execute PostBack and execute that when clicked.

QListBox The QListBox class is based upon QListBoxBase.
QListBoxBase

QListBoxBase will render an HTML DropDown or MultiSelect box [SELECT] element. It extends QListControl. By default, the number of visible rows is set to 1 and the selection mode is set to single, creating a dropdown select box.

QListControl

Abstract object which is extended by anything which involves lists of selectable items. This object is the foundation for the ListBox, CheckBoxList, RadioButtonList and TreeNav. Subclasses can be used as objects to specify one-to-many and many-to-many relationships.

QListItem

Utilized by the QListControl class which contains a private array of ListItems. Originally these represented items in a select list, but now represent items in any kind of control that has repetitive items in it. This includes list controls, menus, drop-downs, and hierarchical lists. This is a general purpose container for the options in each item. Note that not all the options are used by every control, and we don't do any drawing here.

QListItemBase

This base class represents an item in some kind of html item list. There are many types of possible lists, including checklists and hierarchical lists. This is the core functionality common to all of them.

QListItemStyle This defines the style for an Item for a QListControl, which is the base for many different list types.
QNumericTextBox

A subclass of TextBox with its validate method overridden -- Validate will also ensure that the Text is a valid integer/float and (if applicable) is in the range of Minimum <= x <= Maximum. This class is abstract. QIntegerTextBox and QFloatTextBox are derived from it.

QPaginatedControl
QPaginator

Class QPaginator - The paginator control which can be attached to a QDataRepeater or QDataGrid This class will take care of the number of pages, current page, next/previous links and so on automatically.

QPaginatorBase

This controls works together with a QPaginatedControl to implement a paginator for that control. Multiple paginators per QPaginatedControl can be declared.

QPanel

The QPanel Class is defined here. QPanel class can be used to create composite controls which are to be rendered as blocks (not inline)

QProgressbar
QRadioButton This class will render an HTML Radio button.
QRadioButtonList

This class will render a List of HTML Radio Buttons (inhereting from ListControl). By definition, radio button lists are single-select ListControls.

QResizable
QSampleControl

This is a SAMPLE of a custom QControl that you could write. Think of this as a "starting point". Remember: EVERYTHING here is meant to be customized! To use, simply make a copy of this file, rename the file, and edit the renamed file. Remember to specify a control Class name which matches the name of your file. And then implement your own logic for GetControlHtml().

QSelectable
QSlider
QSortable
QTabs QTabs is the PHP wrapper for JQueryUI Tabs control
QTagStyler

A class that encapsulates the styles for a tag. It can be used to swap out a collection of styles for another collection of styles. Note that this is pretty much just an implementation of the QHtmlAttributeManager, which manages both html attributes and css styles. Modern HTML, CSS frameworks and javascript frameworks use more that just the "style" attribute to style an html object.

QTestControl QControl is the user overridable Base-Class for all Controls.
QTextBox
QTimerExpiredEvent

Use this event with the QJsTimer control this event is trigger after a delay specified in QJsTimer (param DeltaTime)

QTreeNav
QTreeNavItem
QUrlTextBox A subclass of TextBox that validates and sanitizes urls.
QWaitIcon
QWriteBox
RecordsSummary

The QPanel Class is defined here. QPanel class can be used to create composite controls which are to be rendered as blocks (not inline)

RefreshForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
SampleForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
SelectableLabel

QLabel class is used to create text on the client side. By default it will not accept raw HTML for text. Set Htmlentities to false to enable that behavior

SpeedForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
TestImageBrowser QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
UrlForm QForm is one of the most important parts of QCubed - it is what ultimately creates the web page
Traits summary
QListItemManager

This is a trait that presents an interface for managing an item list. It is used by the QListControl, QHListControl, and the QHListItem classes, the latter because a QHListItem can itself contain a list of other items.

Exceptions summary
QCrossScriptingException Class QCrossScriptingException: Called when the textbox fails CrossScripting checks
Functions summary
__QForm_EvaluateTemplate_ObHandler
DataGridEvalHandleError

Due to the fact that DataGrid's will perform php eval's on anything that is back-ticked within each column/row's DataGridColumn::HTML, we need to set up this special DataGridEvalHandleError error handler to correctly report errors that happen.

API documentation generated by ApiGen