Gtk2_IndexedComboBox
[ class tree: Gtk2_IndexedComboBox ] [ index: Gtk2_IndexedComboBox ] [ all elements ]

Class: Gtk2_IndexedComboBox_Model

Source Location: /Gtk2_IndexedComboBox-1.1.0/Gtk2/IndexedComboBox/Model.php

Class Overview

GtkListStore
   |
   --Gtk2_IndexedComboBox_Model

Indexed Gtk2 combo box model. Can be used stand-alone e.g. as model for a GtkComboBox from a glade file.


Author(s):

Methods


Inherited Variables

Inherited Methods


Class Details

[line 27]
Indexed Gtk2 combo box model. Can be used stand-alone e.g. as model for a GtkComboBox from a glade file.

Both key and values can be strings or integers.



[ Top ]


Method Detail

__construct (Constructor)   [line 34]

Gtk2_IndexedComboBox_Model __construct( [array $arData = null])

Constructor.
  • Access: public

Parameters:

array   $arData     If wished, you can set the initial data here.

[ Top ]

append   [line 52]

void append( mixed $strId, [string $strValue = null])

Appends a single key/value pair to the list.
  • Access: public

Parameters:

mixed   $strId     (string) id to append, or an array to append
string   $strValue     The value to append

[ Top ]

appendArray   [line 268]

void appendArray( array $arData)

Appends an array (key and value) as data to the store.

Alias of @see append_array().

  • Access: public

Parameters:

array   $arData     The array to append

[ Top ]

append_array   [line 70]

void append_array( array $arData)

Appends an array (key and value) as data to the store.
  • Access: public

Parameters:

array   $arData     The array to append

[ Top ]

getArray   [line 282]

array getArray( )

Returns an array with all key/value pairs.

Alias of @see get_array().

  • Return: Array with key/value pairs in the model
  • Access: public

[ Top ]

get_array   [line 120]

array get_array( )

Returns an array with all key/value pairs.
  • Return: Array with key/value pairs in the model
  • Access: public

[ Top ]

get_key   [line 87]

string get_key( GtkTreeIter $iter)

Returns the key/id of the given iter.

If $iter is NULL, this method returns NULL.

  • Return: The id/key of the selected entry
  • Access: public

Parameters:

GtkTreeIter   $iter     Iterator whose key shall be gotten.

[ Top ]

get_text   [line 105]

string get_text( GtkTreeIter $iter)

Returns the string of the given iter.

If $iter is NULL, this method returns NULL.

  • Return: The string value of the selected entry
  • Access: public

Parameters:

GtkTreeIter   $iter     Iterator whose string shall be gotten.

[ Top ]

insert   [line 146]

void insert( int $nPosition, mixed $strId, [string $strValue = null])

Inserts a single key/value pair (or an array) at a certain position into the list.
  • Access: public

Parameters:

int   $nPosition     The position to insert the values at
mixed   $strId     (string) id to append, or array to append
string   $strValue     The value to append

[ Top ]

insertArray   [line 299]

void insertArray( int $nPosition, array $arData)

Inserts an array (key and value) at a certain position into the list.

Alias of @see insert_array().

  • Access: public

Parameters:

int   $nPosition     The position to insert the array at
array   $arData     The array to append

[ Top ]

insert_array   [line 165]

void insert_array( int $nPosition, array $arData)

Inserts an array (key and value) at a certain position into the list.
  • Access: public

Parameters:

int   $nPosition     The position to insert the array at
array   $arData     The array to append

[ Top ]

prepend   [line 182]

void prepend( mixed $strId, [string $strValue = null])

Prepends a single key/value pair to the list.
  • Access: public

Parameters:

mixed   $strId     (string) id to prepend, or array to prepend
string   $strValue     The value to append

[ Top ]

prependArray   [line 315]

void prependArray( array $arData)

Prepends an array (key and value) at the beginning of the store

Alias of @see prepend_array().

  • Access: public

Parameters:

array   $arData     The array to append

[ Top ]

prepend_array   [line 200]

void prepend_array( array $arData)

Prepends an array (key and value) at the beginning of the store
  • Access: public

Parameters:

array   $arData     The array to append

[ Top ]

removeKey   [line 331]

boolean removeKey( string $strId)

Removes the first entry with the given key from the list.

Alias of @see remove_key().

  • Return: True if an entry has been deleted
  • Access: public

Parameters:

string   $strId     The key of the entry to remove

[ Top ]

remove_key   [line 217]

boolean remove_key( string $strId)

Removes the first entry with the given key from the list.
  • Return: True if an entry has been deleted
  • Access: public

Parameters:

string   $strId     The key of the entry to remove

[ Top ]

setArray   [line 348]

void setArray( array $arData)

Sets an array (key and value) as data into the store.

Clears any previous entries.

Alias of @see set_array().

  • Access: public

Parameters:

array   $arData     The array to set

[ Top ]

set_array   [line 245]

void set_array( array $arData)

Sets an array (key and value) as data into the store.

Clears any previous entries.

  • Access: public

Parameters:

array   $arData     The array to set

[ Top ]


Documentation generated on Fri, 11 Apr 2008 14:30:13 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.