From 7028cbe09c688437910a25623098762bf0fa592d Mon Sep 17 00:00:00 2001 From: David Walter Seikel Date: Mon, 28 Mar 2016 22:28:34 +1000 Subject: Move Irrlicht to src/others. --- .../doc/html/namespaceirr_1_1gui.html | 1889 ++++++++++++++++++++ 1 file changed, 1889 insertions(+) create mode 100644 src/others/irrlicht-1.8.1/doc/html/namespaceirr_1_1gui.html (limited to 'src/others/irrlicht-1.8.1/doc/html/namespaceirr_1_1gui.html') diff --git a/src/others/irrlicht-1.8.1/doc/html/namespaceirr_1_1gui.html b/src/others/irrlicht-1.8.1/doc/html/namespaceirr_1_1gui.html new file mode 100644 index 0000000..a523a58 --- /dev/null +++ b/src/others/irrlicht-1.8.1/doc/html/namespaceirr_1_1gui.html @@ -0,0 +1,1889 @@ + + +
+ +The gui namespace contains useful classes for easy creation of a graphical user interface. +More...
+The gui namespace contains useful classes for easy creation of a graphical user interface.
+enum irr::gui::ECONTEXT_MENU_CLOSE | +
Close behavior. Default is ECMC_REMOVE
+ECMC_IGNORE |
+ do nothing - menu stays open + |
ECMC_REMOVE |
+ remove the gui element + |
ECMC_HIDE |
+ call setVisible(false) + |
Definition at line 16 of file IGUIContextMenu.h.
+ +enum irr::gui::ECURSOR_ICON | +
Default icons for cursors.
+ECI_NORMAL | + |
ECI_CROSS | + |
ECI_HAND | + |
ECI_HELP | + |
ECI_IBEAM | + |
ECI_NO | + |
ECI_WAIT | + |
ECI_SIZEALL | + |
ECI_SIZENESW | + |
ECI_SIZENWSE | + |
ECI_SIZENS | + |
ECI_SIZEWE | + |
ECI_UP | + |
ECI_COUNT | + |
Definition at line 20 of file ICursorControl.h.
+ +enum irr::gui::ECURSOR_PLATFORM_BEHAVIOR | +
platform specific behavior flags for the cursor
+ECPB_NONE |
+ default - no platform specific behavior + |
ECPB_X11_CACHE_UPDATES |
+ On X11 try caching cursor updates as XQueryPointer calls can be expensive. +Update cursor positions only when the irrlicht timer has been updated or the timer is stopped. This means you usually get one cursor update per device->run() which will be fine in most cases. See this forum-thread for a more detailed explanation: http://irrlicht.sourceforge.net/forum/viewtopic.php?f=7&t=45525 + |
Definition at line 82 of file ICursorControl.h.
+ +enum irr::gui::EGUI_ALIGNMENT | +
Definition at line 12 of file EGUIAlignment.h.
+ +enum irr::gui::EGUI_BUTTON_STATE | +
Definition at line 23 of file IGUIButton.h.
+ +enum irr::gui::EGUI_COLUMN_ORDERING | +
modes for ordering used when a column header is clicked
+Definition at line 19 of file IGUITable.h.
+ +enum irr::gui::EGUI_DEFAULT_COLOR | +
Enumeration for skin colors.
+Definition at line 60 of file IGUISkin.h.
+ +enum irr::gui::EGUI_DEFAULT_FONT | +
Definition at line 350 of file IGUISkin.h.
+ +enum irr::gui::EGUI_DEFAULT_ICON | +
Customizable symbols for GUI.
+Definition at line 267 of file IGUISkin.h.
+ +enum irr::gui::EGUI_DEFAULT_SIZE | +
Enumeration for default sizes.
+EGDS_SCROLLBAR_SIZE |
+ default with / height of scrollbar + |
EGDS_MENU_HEIGHT |
+ height of menu + |
EGDS_WINDOW_BUTTON_WIDTH |
+ width of a window button + |
EGDS_CHECK_BOX_WIDTH |
+ width of a checkbox check + |
EGDS_MESSAGE_BOX_WIDTH |
+
|
EGDS_MESSAGE_BOX_HEIGHT |
+
|
EGDS_BUTTON_WIDTH |
+ width of a default button + |
EGDS_BUTTON_HEIGHT |
+ height of a default button + |
EGDS_TEXT_DISTANCE_X |
+ distance for text from background + |
EGDS_TEXT_DISTANCE_Y |
+ distance for text from background + |
EGDS_TITLEBARTEXT_DISTANCE_X |
+ distance for text in the title bar, from the left of the window rect + |
EGDS_TITLEBARTEXT_DISTANCE_Y |
+ distance for text in the title bar, from the top of the window rect + |
EGDS_MESSAGE_BOX_GAP_SPACE |
+ free space in a messagebox between borders and contents on all sides + |
EGDS_MESSAGE_BOX_MIN_TEXT_WIDTH |
+ minimal space to reserve for messagebox text-width + |
EGDS_MESSAGE_BOX_MAX_TEXT_WIDTH |
+ maximal space to reserve for messagebox text-width + |
EGDS_MESSAGE_BOX_MIN_TEXT_HEIGHT |
+ minimal space to reserve for messagebox text-height + |
EGDS_MESSAGE_BOX_MAX_TEXT_HEIGHT |
+ maximal space to reserve for messagebox text-height + |
EGDS_BUTTON_PRESSED_IMAGE_OFFSET_X |
+ pixels to move the button image to the right when a pushbutton is pressed + |
EGDS_BUTTON_PRESSED_IMAGE_OFFSET_Y |
+ pixels to move the button image down when a pushbutton is pressed + |
EGDS_BUTTON_PRESSED_TEXT_OFFSET_X |
+ pixels to move the button text to the right when a pushbutton is pressed + |
EGDS_BUTTON_PRESSED_TEXT_OFFSET_Y |
+ pixels to move the button text down when a pushbutton is pressed + |
EGDS_COUNT |
+ this value is not used, it only specifies the amount of default sizes available. + |
Definition at line 150 of file IGUISkin.h.
+ +enum irr::gui::EGUI_DEFAULT_TEXT | +
Definition at line 229 of file IGUISkin.h.
+ +enum irr::gui::EGUI_ELEMENT_TYPE | +
List of all basic Irrlicht GUI elements.
+An IGUIElement returns this when calling IGUIElement::getType();
+EGUIET_BUTTON |
+ A button (IGUIButton) + |
EGUIET_CHECK_BOX |
+ A check box (IGUICheckBox) + |
EGUIET_COMBO_BOX |
+ A combo box (IGUIComboBox) + |
EGUIET_CONTEXT_MENU |
+ A context menu (IGUIContextMenu) + |
EGUIET_MENU |
+ A menu (IGUIMenu) + |
EGUIET_EDIT_BOX |
+ An edit box (IGUIEditBox) + |
EGUIET_FILE_OPEN_DIALOG |
+ A file open dialog (IGUIFileOpenDialog) + |
EGUIET_COLOR_SELECT_DIALOG |
+ A color select open dialog (IGUIColorSelectDialog) + |
EGUIET_IN_OUT_FADER |
+ A in/out fader (IGUIInOutFader) + |
EGUIET_IMAGE |
+ An image (IGUIImage) + |
EGUIET_LIST_BOX |
+ A list box (IGUIListBox) + |
EGUIET_MESH_VIEWER |
+ A mesh viewer (IGUIMeshViewer) + |
EGUIET_MESSAGE_BOX |
+ A message box (IGUIWindow) + |
EGUIET_MODAL_SCREEN |
+ A modal screen. + |
EGUIET_SCROLL_BAR |
+ A scroll bar (IGUIScrollBar) + |
EGUIET_SPIN_BOX |
+ A spin box (IGUISpinBox) + |
EGUIET_STATIC_TEXT |
+ A static text (IGUIStaticText) + |
EGUIET_TAB |
+ A tab (IGUITab) + |
EGUIET_TAB_CONTROL |
+ A tab control. + |
EGUIET_TABLE |
+ A Table. + |
EGUIET_TOOL_BAR |
+ A tool bar (IGUIToolBar) + |
EGUIET_TREE_VIEW |
+ A Tree View. + |
EGUIET_WINDOW |
+ A window. + |
EGUIET_ELEMENT |
+ Unknown type. + |
EGUIET_ROOT |
+ The root of the GUI. + |
EGUIET_COUNT |
+ Not an element, amount of elements in there. + |
EGUIET_FORCE_32_BIT |
+ This enum is never used, it only forces the compiler to compile this enumeration to 32 bit. + |
Definition at line 17 of file EGUIElementTypes.h.
+ +enum irr::gui::EGUI_EVENT_TYPE | +
Enumeration for all events which are sendable by the gui system.
+EGET_ELEMENT_FOCUS_LOST |
+ A gui element has lost its focus. +GUIEvent.Caller is losing the focus to GUIEvent.Element. If the event is absorbed then the focus will not be changed. + |
EGET_ELEMENT_FOCUSED |
+ A gui element has got the focus. +If the event is absorbed then the focus will not be changed. + |
EGET_ELEMENT_HOVERED |
+ The mouse cursor hovered over a gui element. +If an element has sub-elements you also get this message for the subelements + |
EGET_ELEMENT_LEFT |
+ The mouse cursor left the hovered element. +If an element has sub-elements you also get this message for the subelements + |
EGET_ELEMENT_CLOSED |
+ An element would like to close. +Windows and context menus use this event when they would like to close, this can be cancelled by absorbing the event. + |
EGET_BUTTON_CLICKED |
+ A button was clicked. + |
EGET_SCROLL_BAR_CHANGED |
+ A scrollbar has changed its position. + |
EGET_CHECKBOX_CHANGED |
+ A checkbox has changed its check state. + |
EGET_LISTBOX_CHANGED |
+ A new item in a listbox was selected. +NOTE: You also get this event currently when the same item was clicked again after more than 500 ms. + |
EGET_LISTBOX_SELECTED_AGAIN |
+ An item in the listbox was selected, which was already selected. +NOTE: You get the event currently only if the item was clicked again within 500 ms or selected by "enter" or "space". + |
EGET_FILE_SELECTED |
+ A file has been selected in the file dialog. + |
EGET_DIRECTORY_SELECTED |
+ A directory has been selected in the file dialog. + |
EGET_FILE_CHOOSE_DIALOG_CANCELLED |
+ A file open dialog has been closed without choosing a file. + |
EGET_MESSAGEBOX_YES |
+ 'Yes' was clicked on a messagebox + |
EGET_MESSAGEBOX_NO |
+ 'No' was clicked on a messagebox + |
EGET_MESSAGEBOX_OK |
+ 'OK' was clicked on a messagebox + |
EGET_MESSAGEBOX_CANCEL |
+ 'Cancel' was clicked on a messagebox + |
EGET_EDITBOX_ENTER |
+ In an editbox 'ENTER' was pressed. + |
EGET_EDITBOX_CHANGED |
+ The text in an editbox was changed. This does not include automatic changes in text-breaking. + |
EGET_EDITBOX_MARKING_CHANGED |
+ The marked area in an editbox was changed. + |
EGET_TAB_CHANGED |
+ The tab was changed in an tab control. + |
EGET_MENU_ITEM_SELECTED |
+ A menu item was selected in a (context) menu. + |
EGET_COMBO_BOX_CHANGED |
+ The selection in a combo box has been changed. + |
EGET_SPINBOX_CHANGED |
+ The value of a spin box has changed. + |
EGET_TABLE_CHANGED |
+ A table has changed. + |
EGET_TABLE_HEADER_CHANGED | + |
EGET_TABLE_SELECTED_AGAIN | + |
EGET_TREEVIEW_NODE_DESELECT |
+ A tree view node lost selection. See IGUITreeView::getLastEventNode(). + |
EGET_TREEVIEW_NODE_SELECT |
+ A tree view node was selected. See IGUITreeView::getLastEventNode(). + |
EGET_TREEVIEW_NODE_EXPAND |
+ A tree view node was expanded. See IGUITreeView::getLastEventNode(). + |
EGET_TREEVIEW_NODE_COLLAPSE |
+ A tree view node was collapsed. See IGUITreeView::getLastEventNode(). + |
EGET_TREEVIEW_NODE_COLLAPS |
+ deprecated - use EGET_TREEVIEW_NODE_COLLAPSE instead. This may be removed by Irrlicht 1.9 + |
EGET_COUNT |
+ No real event. Just for convenience to get number of events. + |
Definition at line 151 of file IEventReceiver.h.
+ +enum irr::gui::EGUI_FONT_TYPE | +
An enum for the different types of GUI font.
+Definition at line 19 of file IGUIFont.h.
+ +enum irr::gui::EGUI_LISTBOX_COLOR | +
Enumeration for listbox colors.
+Definition at line 18 of file IGUIListBox.h.
+ +enum irr::gui::EGUI_ORDERING_MODE | +
Definition at line 51 of file IGUITable.h.
+ +enum irr::gui::EGUI_SKIN_TYPE | +
Enumeration of available default skins.
+To set one of the skins, use the following code, for example to set the Windows classic skin:
+gui::IGUISkin* newskin = environment->createSkin(gui::EGST_WINDOWS_CLASSIC); + environment->setSkin(newskin); + newskin->drop(); +
Definition at line 30 of file IGUISkin.h.
+ +enum irr::gui::EGUI_TABLE_DRAW_FLAGS | +
Definition at line 75 of file IGUITable.h.
+ +enum irr::gui::EMESSAGE_BOX_FLAG | +
enumeration for message box layout flags
+Definition at line 14 of file EMessageBoxFlags.h.
+ +const c8* const irr::gui::GUIAlignmentNames[] | +
+{ + "upperLeft", + "lowerRight", + "center", + "scale", + 0 +} +
Names for alignments.
+ +Definition at line 25 of file EGUIAlignment.h.
+ +Referenced by irr::gui::IGUIElement::deserializeAttributes(), and irr::gui::IGUIElement::serializeAttributes().
+ +const c8* const irr::gui::GUIButtonStateNames[] | +
+ { + "buttonUp", + "buttonDown", + "buttonMouseOver", + "buttonMouseOff", + "buttonFocused", + "buttonNotFocused", + 0, + 0, + } +
Names for gui button state icons.
+ +Definition at line 42 of file IGUIButton.h.
+ +const c8* const irr::gui::GUIColumnOrderingNames[] | +
+ { + "none", + "custom", + "ascend", + "descend", + "ascend_descend", + 0, + } +
Names for EGUI_COLUMN_ORDERING types.
+ +Definition at line 41 of file IGUITable.h.
+ +const c8* const irr::gui::GUICursorIconNames[ECI_COUNT+1] | +
+ { + "normal", + "cross", + "hand", + "help", + "ibeam", + "no", + "wait", + "sizeall", + "sizenesw", + "sizenwse", + "sizens", + "sizewe", + "sizeup", + 0 + } +
Names for ECURSOR_ICON.
+ +Definition at line 45 of file ICursorControl.h.
+ +const c8* const irr::gui::GUIElementTypeNames[] | +
+{ + "button", + "checkBox", + "comboBox", + "contextMenu", + "menu", + "editBox", + "fileOpenDialog", + "colorSelectDialog", + "inOutFader", + "image", + "listBox", + "meshViewer", + "messageBox", + "modalScreen", + "scrollBar", + "spinBox", + "staticText", + "tab", + "tabControl", + "table", + "toolBar", + "treeview", + "window", + "element", + "root", + 0 +} +
Names for built-in element types.
+ +Definition at line 103 of file EGUIElementTypes.h.
+ +Referenced by irr::gui::IGUIElement::getTypeName().
+ +const c8* const irr::gui::GUIOrderingModeNames[] | +
+ { + "none", + "ascending", + "descending", + 0 + } +
Definition at line 67 of file IGUITable.h.
+ +const c8* const irr::gui::GUISkinColorNames[EGDC_COUNT+1] | +
+ { + "3DDarkShadow", + "3DShadow", + "3DFace", + "3DHighlight", + "3DLight", + "ActiveBorder", + "ActiveCaption", + "AppWorkspace", + "ButtonText", + "GrayText", + "Highlight", + "HighlightText", + "InactiveBorder", + "InactiveCaption", + "ToolTip", + "ToolTipBackground", + "ScrollBar", + "Window", + "WindowSymbol", + "Icon", + "IconHighlight", + "GrayWindowSymbol", + "Editable", + "GrayEditable", + "FocusedEditable", + 0, + } +
Names for default skin colors.
+ +Definition at line 119 of file IGUISkin.h.
+ +const c8* const irr::gui::GUISkinFontNames[EGDF_COUNT+1] | +
+ { + "defaultFont", + "buttonFont", + "windowFont", + "menuFont", + "tooltipFont", + 0 + } +
Definition at line 367 of file IGUISkin.h.
+ +const c8* const irr::gui::GUISkinIconNames[EGDI_COUNT+1] | +
+ { + "windowMaximize", + "windowRestore", + "windowClose", + "windowMinimize", + "windowResize", + "cursorUp", + "cursorDown", + "cursorLeft", + "cursorRight", + "menuMore", + "checkBoxChecked", + "dropDown", + "smallCursorUp", + "smallCursorDown", + "radioButtonChecked", + "moreLeft", + "moreRight", + "moreUp", + "moreDown", + "expand", + "collapse", + "file", + "directory", + 0 + } +
Definition at line 321 of file IGUISkin.h.
+ +const c8* const irr::gui::GUISkinSizeNames[EGDS_COUNT+1] | +
+ { + "ScrollBarSize", + "MenuHeight", + "WindowButtonWidth", + "CheckBoxWidth", + "MessageBoxWidth", + "MessageBoxHeight", + "ButtonWidth", + "ButtonHeight", + "TextDistanceX", + "TextDistanceY", + "TitleBarTextX", + "TitleBarTextY", + "MessageBoxGapSpace", + "MessageBoxMinTextWidth", + "MessageBoxMaxTextWidth", + "MessageBoxMinTextHeight", + "MessageBoxMaxTextHeight", + "ButtonPressedImageOffsetX", + "ButtonPressedImageOffsetY" + "ButtonPressedTextOffsetX", + "ButtonPressedTextOffsetY", + 0 + } +
Names for default skin sizes.
+ +Definition at line 202 of file IGUISkin.h.
+ +const c8* const irr::gui::GUISkinTextNames[EGDT_COUNT+1] | +
+ { + "MessageBoxOkay", + "MessageBoxCancel", + "MessageBoxYes", + "MessageBoxNo", + "WindowButtonClose", + "WindowButtonMaximize", + "WindowButtonMinimize", + "WindowButtonRestore", + 0 + } +
Names for default skin sizes.
+ +Definition at line 253 of file IGUISkin.h.
+ +const c8* const irr::gui::GUISkinTypeNames[EGST_COUNT+1] | +
+ { + "windowsClassic", + "windowsMetallic", + "burning", + "unknown", + 0, + } +
Names for gui element types.
+ +Definition at line 49 of file IGUISkin.h.
+ +