Unit CastleOpenDocument

Description

Uses

Classes, Interfaces, Objects and Records

Functions and Procedures

Types

Constants

Variables

Description

Opening files and URLs.

Overview

Functions and Procedures

function OpenUrl(AUrl: String): Boolean;

function OpenDocument(APath: String): Boolean;

procedure ShareText(const Title, Subject, Content: string);

procedure OpenApplicationStore(const ApplicationId: string);

procedure Vibrate(const Miliseconds: Cardinal);

procedure OnScreenNotification(const Message: string); deprecated 'This is Android-specific and probably will not be ever supported on other platforms. Better use CGE UI to make cros-platform UI notifications, like TCastleNotifications or just TCastleLabel with animated color/background.';

Constants

SCannotOpenUrl = 'Browser not found on your system.';

Description

Functions and Procedures

function OpenUrl(AUrl: String): Boolean;

Open URL with the suitable application.

This detects and handles also local files (as filenames, or URLs with "file:" protocol).

On Android and iOS, it uses the OS functions to open the URL, supporting all URL types that are handled by the installed applications. For example, it will support the market:// URLs on Android.
On the web, we open the URL by navigating to using window.open.
On desktops, it opens the URL using the default browser.

function OpenDocument(APath: String): Boolean;

Warning: this symbol is deprecated.

Open a local file or directory. You should instead use OpenUrl, that automatically detects local filenames and URLs leading to local filenames.

procedure ShareText(const Title, Subject, Content: string);

Share a text/link through user-choosen application.

This works only on Android and iOS right now.

Parameters

Title: The short title of the share.
Subject: Used as an email subject, and any other app on Android that interprets EXTRA_SUBJECT parameter.
Content: Multi-line share text content, possibly with URL inside.

procedure OpenApplicationStore(const ApplicationId: string);

Show the application in the application store (Google Play on Android, AppStore on iOS). Ignored on other platforms now.

On Android, ApplicationId should be the qualitied name of the application (same thing you use as qualified_name in CastleEngineManifest.xml).
On iOS, ApplicationId has to be the "Apple ID" number of your application (you can see it e.g. in https://itunesconnect.apple.com/ page of your application).

procedure Vibrate(const Miliseconds: Cardinal);

Vibrate the device.

Available on Android, iOS and Nintendo Switch now. Ignored on other platforms.

To include the necessary integration code in your Android project, add the "vibrate" service inside CastleEngineManifest.xml, see https://castle-engine.io/android_services .

procedure OnScreenNotification(const Message: string); deprecated 'This is Android-specific and probably will not be ever supported on other platforms. Better use CGE UI to make cros-platform UI notifications, like TCastleNotifications or just TCastleLabel with animated color/background.';

Warning: this symbol is deprecated: This is Android-specific and probably will not be ever supported on other platforms. Better use CGE UI to make cros-platform UI notifications, like TCastleNotifications or just TCastleLabel with animated color/background.

Simple on-screen notification using Android "toast" call. This is available only on Android right now, ignored elsewhere.

Constants

SCannotOpenUrl = 'Browser not found on your system.';

Model formats support —————————————————— Disable support for some model formats to make the exe smaller.

Note: Don't define these symbols in castleconf.inc, as this would mean you need to maintain your CGE modification, and it affects all projects (including CGE examples that may rely on specific formats).

Rather, define these symbols in your project, e.g. using <defines> in the CastleEngineManifest.xml. See https://castle-engine.io/project_manifest#_compiler_options_and_paths . Like:

<compiler_options> <defines> <define>CASTLE_COLLADA_SUPPORT_DISABLE</define> <define>CASTLE_IFC_SUPPORT_DISABLE</define> </defines> </compiler_options>

Generated by PasDoc 0.16.0-snapshot.

API Reference

Unit CastleOpenDocument

Description

Overview

Functions and Procedures

Constants

Description

Functions and Procedures

Parameters

Constants