PureBasic WebGadget — Procedures

WebGadget Procedures (4)

Cr_WebGadget

Embeds a WebGadget / WebViewGadget into a ContainerGadget allowing for borders.

• url: Validates the URL; if not valid, default HTML code is used.
• flags: Combine at most one from each group.
  • WebView mode (optional — choose one):
    • #Cr_WebView_Gadget
    • #Cr_WebView_Inspect — includes #Cr_WebView_Gadget; same as #PB_WebView_Debug
  • Border style (optional — choose one):
    • #Cr_WebGadget_BorderLess (default)
    • #Cr_WebGadget_Flat
    • #Cr_WebGadget_Raised
    • #Cr_WebGadget_Single
    • #Cr_WebGadget_Double

Cr_WebGadget(gadget, x, y, width, height, url.s = #Null$, flags = #Cr_WebGadget_BorderLess)

Cr_WebGadget_Resize

Resizes both the ContainerGadget and embedded WebGadget / WebViewGadget in a single call.

Cr_WebGadget_Resize(gadget, x, y, width, height)

Cr_WebGadget_SetHTML

Loads a WebGadget / WebViewGadget with HTML code.

• SetGadgetItemText is used with the flag #PB_WebView_HtmlCode.
• html: If not set, default HTML code is used.
• local: If set to #True.
  • Saves the HTML code to a temporary file.
  • Uses SetGadgetText with the file:// protocol.
  • Returns the file path for deletion before program termination.

Cr_WebGadget_SetHTML(gadget, html.s = #Null$, local = #False)

Cr_WebGadget_SetURL

Navigates a WebGadget / WebViewGadget to the specified URL.

• Uses SetGadgetText.
• Validates the URL or falls back to default HTML code.

Cr_WebGadget_SetURL(gadget, url.s)

WebSocket Procedures (3)

Cr_WebSocket_Close

Attempts to cleanly end the running program.

• HideWindow: Set to the #Window Number of the main window (useful if the window does not close immediately).

Cr_WebSocket_Close(HideWindow = #Null)

Cr_WebSocket_Connect

Establishes a network connection to the Chrome DevTools Protocol (CDP) API.

• PageID: Retrieved using the procedure Cr_WebSocket_PageData.
• PortNumber: Optional; use only for specific needs.

Cr_WebSocket_Connect(PageID.s, PortNumber.l = #Null)

Cr_WebSocket_PageData

Extracts page data from a JSON string into a structured List.

• The JSON string is updated via the network connection.
• Whenever a webpage changes, the JSON data is refreshed accordingly.

Cr_WebSocket_PageData(*PageData, List PageData.PAGE_DATA())

WebView Procedures (2)

EnableAcceleratorKeys

Enable or disable browser-specific accelerator keys for the WebViewGadget.

• Enable: Boolean flag controlling the active state of the following accelerator keys.
  • Navigation & Tabs
    • Ctrl+F — Find on page
    • Ctrl+P — Print
    • Ctrl+R / F5 — Refresh
    • Ctrl+Plus / Ctrl+Minus / Ctrl+0 — Zoom in / out / reset
    • Ctrl+Shift+I — Open DevTools
  • Address Bar / History
    • Alt+Left / Alt+Right — Back / Forward
    • F6 — Focus address bar (in some contexts)
  • Page Actions
    • Ctrl+U — View source
    • Ctrl+S — Save page
    • Ctrl+A — Select all (when focused in page context)
    • Ctrl+C / Ctrl+V / Ctrl+X — Copy / Paste / Cut (in some configurations)
  • Developer Tools
    • F12 — Open DevTools
    • Ctrl+Shift+J — Open DevTools console

EnableAcceleratorKeys(Gadget, Enable)

SetWebViewVisible

Set the visibility of a WebViewGadget, typically used when the parent window is minimized and then restored.

• Visible: Boolean flag controlling the visible state of a WebViewGadget.

SetWebViewVisible(Gadget, Visible)

PureBasic Procedures (8)

BringWindowToTop

Brings a window to the top of the Z-order, attaching to the foreground thread if necessary.

• ShowWindow: Boolean flag; when #True (default), the window is also made visible via SW_SHOW.

BringWindowToTop(hWnd, ShowWindow = #True)

CheckInstance

Using the window title as a comparison, checks whether the program is currently running.

• AllowContinue: Boolean flag controlling if a user has the choice to allow multiple program instances.

CheckInstance(WindowTitle.s, AllowContinue = #True)

ConvertBase64

Returns a PureBasic image created from a Base64-encoded string.

• The Base64 string must not include any header data.

ConvertBase64(Base64_Image.s)

FindPortNumber

Searches the active TCP table and returns a port number in the range 9000–9999 that is bound to 127.0.0.1.

• PortNumber: Specifies which matching port to return when multiple ports are found.
  • Accepts a value of 0–9, where 0 returns the first match, 1 returns the second, and so on.

FindPortNumber(PortNumber.l)

ForceActiveWindow

Forces a window to visually appear active without changing actual focus.

• AlwaysActive: Boolean flag controlling the forced active appearance.

ForceActiveWindow(hWnd, AlwaysActive)

GenerateUUID

Generates and returns a random GUID (Globally Unique Identifier), also known as a UUID.

GenerateUUID()

ResizeWindowEx

Animates a window or gadget to a new position and size.

• X / Y: Target position; accepts a coordinate or any of the following flags.
  • #PB_Ignore — Position axis is not changed.
  • #PB_InPlace — Expands or contracts from the center on that axis.
  • #PB_Left / #PB_Right / #PB_Center — Align horizontally within the work area.
  • #PB_Top / #PB_Bottom / #PB_Center — Align vertically within the work area.
• Width / Height: Target size; use #PB_Ignore to leave unchanged.
• DelayTime: Delay in milliseconds between animation steps; defaults to 5.

ResizeWindowEx(Window, X, Y, Width, Height, DelayTime = 5)

ValidateURL

Validates a URL and returns it if valid; otherwise, returns an empty string.

ValidateURL(URL.s)