PHP-GTK Manual

Preface

PHP-GTK Userguide

PHP-GTK Tutorials

PHP-GTK Reference

GTK Classes

GtkAccelGroup

  A structure containing accelerator key data.

GtkAccelLabel

  A label that can display an accelerator key next to the text.

GtkAdjustment

  Represents an adjustable bounded value.

GtkAlignment

  A container that controls the alignment and scale of its child.

GtkArrow

  An arrow pointing in one of the four cardinal directions.

GtkAspectFrame

  A frame that constrains its child to a particular aspect ratio.

GtkBin

  Base class for containers with just one child.

GtkBox

  Base class for box containers.

GtkButton

  A container widget that emits a signal when clicked on.

GtkButtonBox

  Base class for GtkHButtonBox and GtkVButtonBox.

GtkCalendar

  A calendar offering dates that can be selected and marked.

GtkCheckButton

  Button that displays a discrete toggle indicator.

GtkCheckMenuItem

  Menu item with a toggle indicator.

GtkCList

  A multi-columned scrolling list widget.

GtkColorSelection

  Widget that allows for selection of a color.

GtkColorSelectionDialog

  Standard dialog box for selecting a color.

GtkCombo

  Text entry field with a dropdown list.

GtkContainer

  Base class for all container widgets.

GtkCTree

  Widget that displays a hierarchical tree.

GtkCurve

  Widget that allows editing of a curve.

GtkData

  Abstract base class for objects containing data.

GtkDialog

 Widget that eases creation of popup dialogs.

GtkDrawingArea

  Widget for custom user interface elements.

GtkEditable

  Base class for text-editing widgets.

GtkEntry

  A single line text entry field.

GtkEventBox

  Widget used to capture events for widgets with no GdkWindow.

GtkFileSelection

 Widget for selecting a file or a directory.

GtkFixed

  Container that retains the sizes and positions of its children.

GtkFontSelection

  Widget for selecting fonts.

GtkFontSelectionDialog

  Standard dialog box for selecting fonts.

GtkFrame

  Container with a decorative frame and an optional label.

GtkGammaCurve

  A subclass of GtkCurve for editing gamma curves.

GtkHandleBox

  Widget for detachable window portions.

GtkHBox

  Horizontal box container.

GtkHButtonBox

  Container for arranging a group of buttons horizontally.

GtkHPaned

  Container with two panes arranged horizontally.

GtkHRuler

  Horizontal ruler.

GtkHScale

  Horizontal slider widget for selecting a value from a range.

GtkHScrollbar

  Horizontal scrollbar.

GtkHSeparator

  Horizontal separator.

GtkImage

  Widget for displaying a graphical image.

GtkInputDialog

  Standard dialog for configuring input devices.

GtkInvisible

  Internally used widget which is not displayed.

GtkItem

  Abstract base class for GtkMenuItem, GtkListItem, and GtkTreeItem.

GtkItemFactory

  A factory class for simplified menu creation.

GtkLabel

 Widget that displays a small amount of text.

GtkLayout

  Scrollable widget allowing multiple children in fixed positions.

GtkList

  Widget displaying a list of selectable items.

GtkListItem

  A single element in a GtkList.

GtkMenu

  Popup container for menu items.

GtkMenuBar

  Horizontal container for menu items.

GtkMenuItem

  Widget used for item in menus.

GtkMenuShell

  Abstract base class for menu objects.

GtkMisc

  Base class for widgets having their own alignment and padding.

GtkNotebook

  Widget that displays a set of pages with tabs.

GtkObject

  The base class of the PHP-GTK class hierarchy.

GtkOptionMenu

  Widget used to choose from a list of valid choices.

GtkPacker

 

GtkPaned

  Base class for widgets with two adjustable panes.

GtkPixmap

  Widget displaying a graphical image or icon.

GtkPlug

  Toplevel widget for embedding into other processes.

GtkPreview

  Widget to display RGB or grayscale data.

GtkProgress

  Base class for GtkProgressBar.

GtkProgressBar

  Widget that provides a visual indication of an operation's progress.

GtkRadioButton

  Button that is part of a group, only one of which may be selected.

GtkRadioMenuItem

  Menu item that is part of a group, only one of which may be selected.

GtkRange

  Base class for widgets that manipulate the value of a GtkAdjustment.

GtkRuler

  Base class for horizontal and vertical rulers.

GtkScale

  Base class for GtkHScale and GtkVScale.

GtkScrollbar

  Base class for GtkHScrollbar and GtkVScrollbar.

GtkScrolledWindow

  Adds scrollbars to its child widget.

GtkSeparator

  Base class for GtkHSeparator and GtkVSeparator.

GtkSocket

  Container for widgets from other processes.

GtkSpinButton

  Widget offering masked numerical entry and/or selection.

GtkStatusbar

  Widget that provides a way to report messages of minor importance.

GtkStyle

  A class that determines the appearance of widgets.

GtkTable

  Container that provides a flexible grid for packing its children.

GtkTearoffMenuItem

  Menu item used to tear off and reattach its menu.

GtkText

  Editable text-display widget.

GtkTipsQuery

  Displays help about widgets in the user interface.

GtkToggleButton

  Button that retains its state.

GtkToolbar

  Container that creates bars of buttons and other widgets.

GtkTooltips

  Adds tooltips to other widgets.

GtkTree

  Widget for displaying hierarchical information.

GtkTreeItem

  One node of a GtkTree widget.

GtkVBox

  Vertical box container.

GtkVButtonBox

  Container for arranging a group of buttons vertically.

GtkViewport

  Provides scrolling capability for non-scrolling aware widgets.

GtkVPaned

  Container with two panes arranged vertically.

GtkVRuler

  Vertical ruler.

GtkVScale

  Vertical slider widget for selecting a value from a range.

GtkVScrollbar

  Vertical scrollbar.

GtkVSeparator

  Vertical separator.

GtkWidget

  Base class for user interface elements.

GtkWindow

  Widget that provides windows for an application.

GTK Functions

GTK functions not belonging to any class.

Getting a merchant account makes you eligible to accept credit card payments

GDK Classes

GdkAtom

 

GdkBitmap

 

GdkColor

  A structure that holds a defined color.

GdkColormap

  Mapping between the color values stored in memory and the RGB values that are used to display color values.

GdkCursor

  A GdkCursor is represents a predefined or self-created mouse pointer.

GdkDragContext

 

GdkEvent

  One of the stream of mainloop events.

GdkFont

  Structure holding font information.

GdkGC

  A structure that contains graphics information.

GdkPixmap

 

GdkVisual

 

GdkWindow

  Underlying window class for every GtkWidget.

GDK Functions

GDK functions not belonging to any class.

GTK Enums

GdkCapStyle

GdkCursorType

GdkDragAction

GdkEventMask

GdkEventType

GdkFill

GdkFontType

GdkFunction

GdkInputCondition

GdkInputSource

GdkJoinStyle

GdkLineStyle

GdkModifierType

GdkRgbDither

GdkSubwindowMode

GdkVisibilityState

GdkVisualType

GdkWindowType

GTK Extra Classes

add_column()

 Add a column at a specific position

add_row()

 Add a row at a specific position

attach()

 Attach a widget to a cell.

button_attach()

 Attach a button???

cell_clear()

 Clear a cell (remove contents)

cell_delete()

 Removes all the content from a cell

cell_get_state()

 Get the cell state???

cell_get_text()

 Get the content of a cell

change_entry()

 ???

columns_labels_set_visibility()

 Shows or hides the column labels

columns_set_sensitivity()

 Sets the sensitivity of all columns - like col_set_sensitivity, but for all rows

column_button_add_label()

 Add a label to the column title

column_button_justify()

 Sets the alignment of a column title

column_label_set_visibility()

 Shows or hides a column title

column_set_justification()

 Set the justification/alignment of a whole column

column_set_sensitivity()

 Set the column sensivity.

column_set_visibility()

 Shows or hides an entire column

construct()

 ...

construct_browser()

 ???

construct_with_custom_entry()

 ???

delete_columns()

 Delete columns from the sheet

delete_rows()

 Delete rows from the sheet

freeze()

 Freeze the widget.

get_active_cell()

 Returns the position of the active cell

get_columns_count()

 Get the number of columns defined in the GtkSheet

get_entry()

 [perhaps] Returns the entry used for cell content insertion

get_entry_widget()

 Returns the widget with which you enter the text in the cells

get_rows_count()

 Get the number of rows defined in the GtkSheet

get_state()

 Checks the state????

grid_visible()

 Checks if the grid is visible

hide_column_titles()

 Hide the column titles on the top

hide_row_titles()

 Hide the row titles on the left side

insert_columns()

 Insert a number of columns into the sheet

insert_rows()

 Insert a number of columns into the sheet

moveto()

 ???

move_child()

 ???

remove_link()

 ...

rows_labels_set_visibility()

 Hides or shows all row titles

rows_set_sensitivity()

 Sets the sensitivity of all rows.

row_button_add_label()

 Add a label to the row title

row_button_justify()

 Sets the alignment of a row title

row_label_set_visibility()

 Shows or hides a row title

row_set_sensitivity()

 Set the row sensivity.

row_set_visibility()

 Shows or hides an entire row

select_column()

 Select an entire column

select_row()

 Select an entire row

set_active_cell()

 Activate/select one cell

set_background()

 Set the background color of the whole sheet

set_cell()

 Set the contents of a cell

set_cell_text()

 Set the text of a cell

set_column_title()

 Set the title of a column

set_column_titles_height()

 Set the height of the column titles

set_column_width()

 Set the width of a column

set_grid()

 Set the color of the grid lines

set_hadjustment()

 ...

set_row_height()

 Set the height of a row

set_row_title()

 Set the title of a row

set_row_titles_width()

 Set the width of the row titles on the left

set_selection_mode()

 Set the selection mode

set_title()

 Set the title of the whole sheet

set_vadjustment()

 ...

show_column_titles()

 Make the column titles visible

show_grid()

 Show or hide the grid

show_row_titles()

 Show the row titles

thaw()

 Continue updating the widget

unclip_range()

 ...

unselect_range()

 Removes a selection on more than 1 cell leaving only 1 cell selected

GDK Enums

GtkAccelFlags

GtkAnchorType

GtkArrowType

GtkAttachOptions

GtkButtonAction

GtkButtonBoxStyle

GtkCalendarDisplayOptions

GtkCellType

GtkCornerType

GtkCTreeExpanderStyle

GtkCTreeExpansionType

GtkCTreeLineStyle

GtkCurveType

GtkDestDefaults

GtkDirectionType

GtkFontFilterType

GtkFontType

GtkJustification

GtkObjectFlags

GtkOrientation

GtkPackerOptions

GtkPackType

GtkPolicyType

GtkPositionType

GtkPreviewType

GtkProgressBarOrientation

GtkProgressBarStyle

GtkReliefStyle

GtkResizeMode

GtkScrollType

GtkSelectionMode

GtkShadowType

GtkSideType

GtkSortType

GtkSpinButtonUpdatePolicy

GtkSpinType

GtkStateType

GtkSubmenuPlacement

GtkToolbarChildType

GtkToolbarSpaceStyle

GtkToolbarStyle

GtkTreeViewMode

GtkUpdateType

GtkVisibility

GtkWidgetFlags

GtkWindowPosition

GtkWindowType

Glade Classes

Scintilla Classes

find_text()

  Finds a portion of text in GtkScintilla.

add_text()

  Add the string at the end of text area.

insert_text()

  Inserts text in the text area of GtkScintilla.

clear_all()

  Clear all text area.

clear_document_style()

 

get_length()

  Gets the length of the text inside the text area.

get_current_pos()

  Gets the current position of cursor. It means the character position inside the text.

get_char_at()

  Return the character that is located at the specific position.

get_anchor()

 

get_style_at()

 

redo()

  Redo is like "redo" action of every text editor. Redo does again some task undone by "Undo" operation.

set_undo_collection()

 

select_all()

  Select all text inside the text area.

set_save_point()

 

marker_line_from_handle()

 

marker_delete_handle()

 

get_undo_collection()

 

get_view_ws()

 

set_view_ws()

 

position_from_point()

 

goto_line()

  This method set the cursor position to the specific line.

goto_pos()

  This method set the cursor position to the specific character position.

set_anchor()

 

get_cur_line()

  Returns an array containing the current line string and the current column.

get_end_styled()

 

convert_eols()

 

get_eol_mode()

  Return the current End of Line Mode. See set_eol_mode() .

set_eol_mode()

  Define the End of Line Mode.

start_styling()

 

set_styling()

 

get_buffered_draw()

 

set_buffered_draw()

 

set_tab_width()

  Set the Tab Width.

get_tab_width()

  Gets the Tab Width.

set_code_page()

 

set_use_palette()

 

marker_define()

  Define a specific symbol for a marker number.

marker_set_fore()

  Set the Fore color of a marker, for markers table, see marker_define()

marker_set_back()

  Set the Background color of a marker, for markers table, see marker_define()

marker_add()

  Add a Marker symbol in front of the line, for markers table, see marker_define()

marker_delete()

  Deletes a Marker symbol from the line, for markers table, see marker_define()

marker_delete_all()

  Removes all line markers of a specific type, for markers table, see marker_define()

marker_get()

 

marker_next()

 

marker_previous()

 

set_margin_type_n()

 

get_margin_type_n()

 

set_margin_width_n()

 

get_margin_width_n()

 

set_margin_mask_n()

 

get_margin_mask_n()

 

set_margin_sensitive_n()

 

get_margin_sensitive_n()

 

style_clear_all()

 

style_set_fore()

  Set the fore color of some style.

style_set_back()

  Set the background color of some style.

style_set_bold()

  Define some style to be formated as bold.

style_set_italic()

  Define some style to be formated as italic.

style_set_size()

  Define the size of some style

style_set_font()

  Set the font of some style.

style_set_eol_filled()

 

style_reset_default()

 

style_set_underline()

  Define some style to be formated as underlined.

style_set_case()

  Turn OFF/ON the Case Sensitive of some Style.

style_set_character_set()

 

set_sel_fore()

  Set the fore color of the selection.

set_sel_back()

  Set the back color of the selection.

set_caret_fore()

 

get_caret_fore()

 

clear_all_cmd_keys()

 

set_styling_ex()

 

style_set_visible()

  Define if some style will be visible or not.

get_caret_period()

 

set_caret_period()

 

set_word_chars()

 

begin_undo_action()

  Define when start to store the actions of the user for "Undo Action".

end_undo_action()

  Define when finish to store the actions of the user for "Undo Action".

indic_set_style()

 

indic_get_style()

 

indic_set_fore()

 

indic_get_fore()

 

set_style_bits()

 

get_style_bits()

 

set_line_state()

 

get_line_state()

 

get_max_line_state()

 

set_caret_line_visible()

  Define if the selected line must have the background in another color.

get_caret_line_visible()

  Return if caret lines are visible or not.

get_caret_line_back()

  Get the background color of Caret Lines.

set_caret_line_back()

  Changes the background color of the Caret Lines.

autoc_show()

  Show the auto-complation list.

autoc_cancel()

 

autoc_active()

 

autoc_pos_start()

 

autoc_complete()

 

autoc_stops()

 

autoc_set_separator()

 

autoc_get_separator()

 

autoc_select()

 

autoc_set_cancel_at_start()

 

autoc_get_cancel_at_start()

 

autoc_set_fill_ups()

 

autoc_set_choose_single()

 

autoc_get_choose_single()

 

autoc_set_ignore_case()

 

autoc_get_ignore_case()

 

user_list_show()

 

autoc_set_auto_hide()

 

autoc_get_auto_hide()

 

set_indent()

  Set indentation size.

get_indent()

  Get Indentation Size.

set_use_tabs()

  Set if the [TAB] key must use tabs or spaces.

get_use_tabs()

  Get if the [TAB] key is using tabs or spaces.

set_line_indentation()

  Set the line indentation of some line.

get_line_indentation()

  Get the Line indentation of some line.

get_line_indent_position()

 

get_column()

  Returns the column number of the character position.

set_h_scroll_bar()

 

get_h_scroll_bar()

 

set_indentation_guides()

  Set wheather the indentation guides are visible or not.

get_indentation_guides()

  Get wheather the indentation guides are visible or not.

set_highlight_guide()

 

get_highlight_guide()

 

get_line_end_position()

 

get_code_page()

 

get_use_palette()

 

get_read_only()

 

set_current_pos()

 

set_selection_start()

  Set the start of the selection (character position).

get_selection_start()

  Get the begin of the selection (character position).

set_selection_end()

  Set the end of the selection (character position).

get_selection_end()

  Get the end of the selection (character position).

set_print_magnification()

 

get_print_magnification()

 

set_print_colour_mode()

 

get_print_colour_mode()

 

get_first_visible_line()

 

get_line()

  Get the content of some line.

get_line_count()

  Get the quantity of lines of the text area.

set_margin_left()

 

get_margin_left()

 

set_margin_right()

 

get_margin_right()

 

get_modify()

 

set_sel()

 

get_sel_text()

  Get the selected text.

hide_selection()

 

point_x_from_position()

 

point_y_from_position()

 

line_from_position()

  Get the line number from character position.

position_from_line()

  Get the character position from the line number.

line_scroll()

 

scroll_caret()

 

replace_sel()

 

set_read_only()

  Define if the text area may be edited or not.

null()

 

can_redo()

  Can Redo returns wheather "Redo" Operation may be done or not.

can_paste()

  Can Paste returns wheather "Paste" Operation may be done or not.

can_undo()

  Can Undo returns wheather "Undo" Operation may be done or not.

empty_undo_buffer()

  Empty the action list for "Undo" Action.

undo()

  Undo makes the last action undone.

cut()

  Cut the selected text and transfer it to the memory.

copy()

  Copy the selected text and transfer it to the memory.

paste()

  Paste the selected text from the memory to the text area.

clear()

 

set_text()

  Set all the content of Scintilla text area edition with the specified string.

get_text()

  Return all the content of Scintilla text area edition as a string.

get_text_length()

  Return the length of the text inside scintilla object.

get_direct_function()

 

get_direct_pointer()

 

set_overtype()

 

get_overtype()

 

set_caret_width()

 

get_caret_width()

 

set_target_start()

 

get_target_start()

 

set_target_end()

 

get_target_end()

 

replace_target()

 

replace_target_re()

 

search_in_target()

 

set_search_flags()

 

get_search_flags()

 

call_tip_show()

  Show the sintax hint about one function

call_tip_cancel()

 

call_tip_active()

 

call_tip_pos_start()

 

call_tip_set_hlt()

 

call_tip_set_back()

 

visible_from_doc_line()

 

doc_line_from_visible()

 

set_fold_level()

  Define the fold level for some line. Fold level means the level of braces {} in the code.

get_fold_level()

  Returns the fold level for some line. See set_fold_level()

get_last_child()

 

get_fold_parent()

 

show_lines()

  Show the specified lines.

hide_lines()

  Hide the specified lines.

get_line_visible()

 

set_fold_expanded()

 

get_fold_expanded()

 

toggle_fold()

 

ensure_visible()

 

set_fold_flags()

 

set_tab_indents()

 

get_tab_indents()

 

set_backspace_unindents()

 

get_backspace_unindents()

 

line_down()

  Places the cursor one line down.

line_down_extend()

  Selects one line down.

line_up()

  Places the cursor one line up.

line_up_extend()

  Selects one line up.

char_left()

  Places the cursor one character to the left.

char_left_extend()

  Selects the character at the left side.

char_right()

  Places the cursor one character to the right.

char_right_extend()

  Selects the character at the right side.

word_left()

  Places the cursor one word to the left.

word_left_extend()

  Selects the word at the left side.

word_right()

  Places the cursor one word to the right.

word_right_extend()

  Selects the word at the right side.

home()

  Places the cursor at the begin of the line.

home_extend()

  Selects the text untill the home of the line.

line_end()

  Places the cursor at the end of the line.

line_end_extend()

  Selects the text untill the end of the line.

document_start()

 

document_start_extend()

 

document_end()

 

document_end_extend()

 

page_up()

  Goes one page up.

page_up_extend()

  Selects the text of one page up.

page_down()

  Goes one page down.

page_down_extend()

  Selects the text of one page down.

edit_toggle_overtype()

 

cancel()

 

delete_back()

 

tab()

 

back_tab()

 

new_line()

 

form_feed()

 

v_c_home()

 

v_c_home_extend()

 

zoom_in()

 

zoom_out()

 

del_word_left()

  Delete word of the left side of the cursor.

del_word_right()

  Delete word of the right side of the cursor.

line_cut()

  Cuts the current line's content to the memory.

line_delete()

  Deletes the current line.

line_transpose()

 

lower_case()

 

upper_case()

 

line_scroll_down()

 

line_scroll_up()

 

move_caret_inside_view()

 

line_length()

  Return the length of some line.

brace_match()

  Get the character position of the complement of "{", "[", "("

brace_highlight()

  Set positions inside the text to be showed in brace mode.

brace_bad_light()

 

get_view_eol()

  Get wheather the end of line marks are visible or not.

set_view_eol()

  Define wheather the end of line marks are visible or not.

get_doc_pointer()

 

set_doc_pointer()

 

set_mod_event_mask()

 

get_edge_column()

  Returns the column number that is used as the edge of text area.

set_edge_column()

  Changes the column number that is used as the edge of the text area.

get_edge_mode()

  Returns the edge mode. See set_edge_mode()

set_edge_mode()

  Changes the edge mode.

get_edge_colour()

  Gets the background color of text out of the edge.

set_edge_colour()

  Changes the background color of text out of the edge.

search_anchor()

 

search_next()

 

search_prev()

 

set_caret_policy()

 

lines_on_screen()

 

use_pop_up()

 

selection_is_rectangle()

 

set_zoom()

 

get_zoom()

 

create_document()

 

add_ref_document()

 

release_document()

 

get_mod_event_mask()

 

set_focus()

 

get_focus()

 

set_status()

 

get_status()

 

set_mouse_down_captures()

 

get_mouse_down_captures()

 

set_cursor()

 

get_cursor()

 

word_part_left()

 

word_part_left_extend()

 

word_part_right()

 

word_part_right_extend()

 

set_visible_policy()

 

del_line_left()

 

del_line_right()

 

grab_focus()

 

start_record()

 

stop_record()

 

set_lexer()

  Define what kind of lexer language will be used to highlight the code.

get_lexer()

  Return what kind of lexer language is used to highlight the code. See set_lexer() .

colourise()

 

set_property()

 

set_keywords()

  Define the keywords list for some keywords set.

set_lexer_language()

Sqpane Classes

Appendix