ui/ui/webview.h

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2025 Olaf Wintermann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef UI_WEBVIEW_H
#define UI_WEBVIEW_H

#include "toolkit.h"


#ifdef __cplusplus
extern "C" {
#endif
    
/*
 * WebView type string used by UiGeneric
 */
#define UI_WEBVIEW_OBJECT_TYPE "webview"

/*
 * UiWebViewData* is returned by a webviews UiGeneric->get function
 */
typedef struct UiWebViewData UiWebViewData;

typedef struct UiWebviewArgs {
    UiBool fill;
    UiBool hexpand;
    UiBool vexpand;
    UiBool hfill;
    UiBool vfill;
    UiBool override_defaults;
    int margin;
    int margin_left;
    int margin_right;
    int margin_top;
    int margin_bottom;
    int colspan;
    int rowspan;
    const char *name;
    const char *style_class;
    
    UiGeneric *value;
    const char *varname;
    
    const int* groups;
} UiWebviewArgs;

#define ui_webview(obj, ...) ui_webview_create(obj, &(UiWebviewArgs){ __VA_ARGS__ } )

UIEXPORT UIWIDGET ui_webview_create(UiObject *obj, UiWebviewArgs *args);

UIEXPORT void ui_webview_load_url(UiGeneric *g, const char *url);

UIEXPORT void ui_webview_load_content(
        UiGeneric *g,
        const char *uri,
        const char *content,
        size_t contentlength,
        const char *mimetype,
        const char *encoding);

/*
 * Frees a UiWebViewData object returned by a webviews UiGeneric->get function
 */
UIEXPORT void ui_webview_data_free(UiWebViewData *data);

UIEXPORT void ui_webview_reload(UiGeneric *g);
UIEXPORT UiBool ui_webview_can_go_back(UiGeneric *g);
UIEXPORT UiBool ui_webview_can_go_forward(UiGeneric *g);
UIEXPORT void ui_webview_go_back(UiGeneric *g);
UIEXPORT void ui_webview_go_forward(UiGeneric *g);
UIEXPORT const char * ui_webview_get_uri(UiGeneric *g);
UIEXPORT void ui_webview_enable_javascript(UiGeneric *g, UiBool enable);
UIEXPORT void ui_webview_set_zoom(UiGeneric *g, double zoom);
UIEXPORT double ui_webview_get_zoom(UiGeneric *g);


#ifdef __cplusplus
}
#endif

#endif /* UI_WEBVIEW_H */