GuiCreateBrowser: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client_function}} {{New feature/item|3.0150|1.5|| This function creates a new CEGUI web browser element. }} ==Syntax== <syntaxhighlight lang="lua">element cr...")
 
mNo edit summary
Line 7: Line 7:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">element createBrowser ( float x, float y, float width, float height, bool isLocal, bool isRelative [, element parent = nil] )</syntaxhighlight>
<syntaxhighlight lang="lua">element createBrowser ( float x, float y, float width, float height, bool isLocal, bool isRelative [, element parent = nil] )</syntaxhighlight>
{{OOP||[[Element/GuiBrowser|browser]].create||guiCreateBrowser}}
{{OOP||[[Element/gui-browser|GuiBrowser]].create||guiCreateBrowser}}


===Required Arguments===
===Required Arguments===

Revision as of 17:05, 12 April 2015

This function creates a new CEGUI web browser element.

Syntax

element createBrowser ( float x, float y, float width, float height, bool isLocal, bool isRelative [, element parent = nil] )

OOP Syntax Help! I don't understand this!

Method: GuiBrowser.create(...)
Counterpart: guiCreateBrowser


Required Arguments

  • x, y: The browser's position
  • width: The browser's native width
  • height: The browser's native height
  • isLocal: See examples
  • isRelative: This is whether sizes and positioning are relative. If this is true, then all x,y,width,height floats must be between 0 and 1, representing measures relative to the parent.

Optional Arguments

  • parent: This is the parent that the radio button is attached to. If the relative argument is true, sizes and positioning will be made relative to this parent. If the relative argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

Returns

Returns true if the gui-browser element was successfully created, false otherwise. Returns also false, if the user disabled remote pages and isLocal was set to false.

Example

This examples attached a webbrowser to a CEGUI window 

--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

--Let's create a new browser in remote mode.
local window = guiCreateWindow(200, 200, 1024, 768, "Webbrowser", false)
local browser = guiCreateBrowser(0, 0, 800, 600, false, false, window)

-- The event onClientBrowserCreated will be triggered, after the browser has been initialized.
-- After this event has been triggered, we will be able to load our URL
local theBrowser = guiGetBrowser(browser) -- Get the browser element from gui-browser
addEventHandler("onClientBrowserCreated", theBrowser, 
	function()
		-- After the browser has been initialized, we can load www.youtube.com
		loadBrowserURL(source, "http://www.youtube.com")
	end
)

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiCreateBrowser?oldid=44975"