struct CCL::ISystemShell

Overview

Interface to interact with operating system graphical shell. More…

#include <isystemshell.h>

struct ISystemShell: public CCL::IUnknown
{
    // methods

    virtual tresult CCL_API openUrl (UrlRef url, int flags = 0) = 0;
    virtual tresult CCL_API showFile (UrlRef url) = 0;
    virtual tresult CCL_API addRecentFile (UrlRef url) = 0;
    virtual tresult CCL_API setRunAtStartupEnabled (tbool state) = 0;
    virtual tbool CCL_API isRunAtStartupEnabled () = 0;
    virtual tbool CCL_API isRunAtStartupHidden (ArgsRef args) = 0;
    virtual tresult CCL_API openApplicationSettings () = 0;

    virtual IAsyncOperation*CCL_API startBrowserAuthentication (
        UrlRef url,
        StringRef scheme,
        IWindow* window = nullptr
    ) = 0;
};

Inherited Members

public:
    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;

Detailed Documentation

Interface to interact with operating system graphical shell.

Access singleton via System::GetSystemShell(). [guiservices.h] - #include “ccl/public/guiservices.h”

Methods

virtual tresult CCL_API openUrl (UrlRef url, int flags = 0) = 0

Open URL in this or external application.

Can be a local document or a website.

virtual tresult CCL_API showFile (UrlRef url) = 0

Show file or folder in system file management application (File Explorer on Windows, Finder on macOS, etc.).

virtual tresult CCL_API addRecentFile (UrlRef url) = 0

Notifies system that a file has been accessed.

virtual tresult CCL_API setRunAtStartupEnabled (tbool state) = 0

Enable auto-start for current application.

virtual tbool CCL_API isRunAtStartupEnabled () = 0

Check if auto-start is enabled.

virtual tbool CCL_API isRunAtStartupHidden (ArgsRef args) = 0

Check if application should hide window when auto-starting.

virtual tresult CCL_API openApplicationSettings () = 0

Open the mobile platform settings page for current application.

Not implemented for desktop platforms.

virtual IAsyncOperation*CCL_API startBrowserAuthentication (
    UrlRef url,
    StringRef scheme,
    IWindow* window = nullptr
) = 0

Start authentication session via default web browser.

Callback scheme must be registered with current application. Operation result is IUrl with callback data.