Class: TTK_Window

Source Location: Program_Root/ticatk/widgets/window.inc

Class Overview

TTK_TKNode
   |
   --TTK_Widget
      |
      --TTK_Window

TicaTK Window

Author(s):

Version:

  • $Revision: 1.7 $

Copyright:

  • © 2001, 2002, 2003 Coleebris

Variables

Methods


Child classes:

Inherited Variables

Inherited Methods

Class: TTK_Widget

constructor TTK_Widget ( &$ticatk, [$id = false] )
TTK_Widget constructor
label_format ( $v )
Html format trim() + htmlentities()
set_img ( $attname, $imgsrc, [$local = false] )
As set_attr() with automatic adding of image size
watch_attr ( $attr, $callback )
Register a callback which will be called whenever this widget have specified attribute modified by the client The callback will be called with two arguments : this object and the attribute name
watch_close ( $callback )
Register a callback which will be called whenever this widget is closed by the client The callback will be called with one argument : this object id

Class: TTK_TKNode

constructor TTK_TKNode ( &$ticatk, &$doc, [$id = false] )
TTK_TKNode Constructor
&append_child ( $obj )
Append a node
close ( )
Delete the node
get_attr ( $attr )
Get value of a node attribute
get_bool_attr ( $attr )
Get boolean value of a node attribute
&get_child ( $id )
Get a child by id.
get_childs ( )
Get node's childs
get_id ( )
Get the node's id
get_id_attr ( $attr, [$return_object = true] )
Get value of a node attribute with optional automatic from value to an instance of TTK_TKNode (or subclass)
&get_parent ( )
Get the parent node
&get_ttk_object ( $node, $ticatk )
Map and return a TTK object from a DomNode
remove ( )
Remove the node from parent
set_attr ( $attr, $value, [$local = false] )
Set value of a node attribute
set_bool_attr ( $attr, $value, [$local = false] )
Set boolean value of a node attribute
set_id_attr ( $attr, $value, [$local = false] )
Set value of a node attribute with automatic conversion of value to id if value is an instance of TTK_TKNode (or subclass)
_associate ( $ticatk, $domnode )
Associate a DomNode to this node


Class Details

TicaTK Window

Tags:

[ Top ]


Class Variables


Class Methods

get_menu

mixed get_menu ( [$return_object = true] )

Get the associated menu of the window if any

Tags:

Parameters:

  • boolean $return_object - If set to false, the id of the menu will be returned

[ Top ]

get_position

array(left, get_position ( )

Get the position of the window

Tags:

  • Return - top)

Parameters:

[ Top ]

get_size

array(width, get_size ( )

Get the width & height of the window

Tags:

  • Return - height)

Parameters:

[ Top ]

get_title

string get_title ( )

Get the window's title

Tags:

Parameters:

[ Top ]

is_closable

boolean is_closable ( )

Return true if the window is closable

Tags:

Parameters:

[ Top ]

is_droptarget

boolean is_droptarget ( )

Return true if the window is a drop target

Tags:

Parameters:

[ Top ]

is_iconifiable

boolean is_iconifiable ( )

Return true if the window is iconifiable

Tags:

Parameters:

[ Top ]

is_maximizable

boolean is_maximizable ( )

Return true if the window is maximizable

Tags:

Parameters:

[ Top ]

is_resizable

boolean is_resizable ( )

Return true if the window is resizable

Tags:

Parameters:

[ Top ]

is_visible

boolean is_visible ( $visible )

Get the window's visibility

Tags:

Parameters:

[ Top ]

move

void move ( $left, $top )

Move the window

Tags:

Parameters:

  • mixed $left - (int|"left"|"center"|"right")
  • mixed $top - (int|"top"|"middle"|"bottom")

[ Top ]

resize

void resize ( $width, $height )

Set the width & height of the window

Tags:

Parameters:

  • mixed $width - ("scn"|"scnby2"|"scnby3"|"scnby4"|w)
  • mixed $height("scn"|"scnby2"|"scnby3"|"scnby4"|h) -

[ Top ]

set_closable

void set_closable ( $value )

Set if the window can be closed by the user

Tags:

Parameters:

  • boolean $value -

[ Top ]

set_droptarget

void set_droptarget ( $value )

Set if the window can be a drop target

Tags:

Parameters:

  • boolean $value -

[ Top ]

set_iconifiable

void set_iconifiable ( $value )

Set if the window can be iconified by the user

Tags:

Parameters:

  • boolean $value -

[ Top ]

set_maximizable

void set_maximizable ( $value )

Set if the window can be maximized by the user

Tags:

Parameters:

  • boolean $value -

[ Top ]

set_menu

void set_menu ( $menu )

Associate a menu to the window

Tags:

Parameters:

  • mixed $menu - (TTK_Menu object | TTK_Menu id)

[ Top ]

set_resizable

void set_resizable ( $value )

Set if the window can be resized by the user

Tags:

Parameters:

  • boolean $value -

[ Top ]

set_title

void set_title ( $value, [$noformat = false] )

Set the window's title

Tags:

Parameters:

  • string $value -
  • boolean $noformat - Do not apply TTK_Widget::label_format()

[ Top ]

set_visible

void set_visible ( $visible )

Set the window's visibility

Tags:

Parameters:

  • boolean $value -

[ Top ]

constructor TTK_Window

void constructor TTK_Window ( &$ticatk, [$id = false], [$title = false], [$left = false], [$top = false], [$width = false], [$height = false], [$topmenu = false], [$iconifiable = false], [$closable = false], [$resizable = false], [$droptarget = false], [$help = false], [$maximizable = false] )

TTK_Window constructor

Tags:

Parameters:

  • object $ticatk - TTK_TicaTK
  • string $id - Window identity
  • string $title - Window title
  • mixed $left - Left position ( "left" | "center" | "right" | x pixel)
  • mixed $top - Top position ("top" | "middle" | "bottom" | y pixel)
  • mixed $width - Width ("scn" | "scnby2" | "scnby3" | "scnby4" | w pixel)
  • mixed $height - Height ("scn" | "scnby2" | "scnby3" | "scnby4" | h pixel)
  • mixed $topmenu - TTK_Menu or TTK_Menu id
  • boolean $iconifiable -
  • boolean $closable -
  • boolean $resizable -
  • boolean $droptarget -
  • boolean $help -
  • boolean $maximizable -

[ Top ]


Documention generated on Mon, 17 Feb 2003 16:18:28 +0100 by phpDocumentor 1.1.0