io.qt.webengine.core.QWebEngineFrame Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtjambi-webenginecore Show documentation
Provides public API shared by both modules {@code qtjambi.webenginequick} and {@code qtjambi.webenginewidgets}.
There is a newer version: 6.7.2
Show newest version
package io.qt.webengine.core;

import io.qt.*;


/**
 * Gives information about and control over a page frame
 * Java wrapper for Qt class QWebEngineFrame
 * @since This class was introduced in Qt 6.8.
 */
public final class QWebEngineFrame extends QtObject
    implements java.lang.Cloneable
{
    static {
        QtJambi_LibraryUtilities.initialize();
    }
    
    /**
     * This variable stores the meta-object for the class.
     */
    public static final io.qt.core.@NonNull QMetaObject staticMetaObject = io.qt.core.QMetaObject.forType(QWebEngineFrame.class);
    
    
    /**
     * See QWebEngineFrame::QWebEngineFrame(QWebEngineFrame)
     * @param other
     */
    public QWebEngineFrame(io.qt.webengine.core.@StrictNonNull QWebEngineFrame other){
        super((QPrivateConstructor)null);
        java.util.Objects.requireNonNull(other, "Argument 'other': null not expected.");
        initialize_native(this, other);
    }
    
    private native static void initialize_native(QWebEngineFrame instance, io.qt.webengine.core.QWebEngineFrame other);
    
    /**
     * See QWebEngineFrame::children()const
     * @return
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList children(){
        return children_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QList children_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineFrame::htmlName()const
     * @return
     */
    @QtPropertyReader(name="htmlName")
    @QtUninvokable
    public final java.lang.@NonNull String htmlName(){
        return htmlName_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String htmlName_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineFrame::isMainFrame()const
     * @return
     */
    @QtPropertyReader(name="isMainFrame")
    @QtUninvokable
    public final boolean isMainFrame(){
        return isMainFrame_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean isMainFrame_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineFrame::isValid()const
     * @return
     */
    @QtPropertyReader(name="isValid")
    @QtUninvokable
    public final boolean isValid(){
        return isValid_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean isValid_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineFrame::name()const
     * @return
     */
    @QtPropertyReader(name="name")
    @QtUninvokable
    public final java.lang.@NonNull String name(){
        return name_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String name_native_constfct(long __this__nativeId);
    
    /**
     * See operator==(QWebEngineFrame,QWebEngineFrame)
     * @param rhs
     * @return
     */
    @QtUninvokable
    public final boolean equals(io.qt.webengine.core.@StrictNonNull QWebEngineFrame rhs){
        java.util.Objects.requireNonNull(rhs, "Argument 'rhs': null not expected.");
        return equals_native_cref_QWebEngineFrame(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(rhs));
    }
    
    @QtUninvokable
    private native boolean equals_native_cref_QWebEngineFrame(long __this__nativeId, long rhs);
    
    /**
     * See QWebEngineFrame::printToPdf(QJSValue)
     * @param callback
     */
    @SuppressWarnings({"exports"})
    public final void printToPdf(io.qt.qml.@NonNull QJSValue callback){
        printToPdf_native_cref_QJSValue(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(callback));
    }
    
    private native void printToPdf_native_cref_QJSValue(long __this__nativeId, long callback);
    
    /**
     * See QWebEngineFrame::printToPdf(QString)
     * @param filePath
     */
    public final void printToPdf(java.lang.@NonNull String filePath){
        printToPdf_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), filePath);
    }
    
    private native void printToPdf_native_cref_QString(long __this__nativeId, java.lang.String filePath);
    
    /**
     * See QWebEngineFrame::printToPdf(const std::function<void(const QByteArray&)>&)
     * @param callback
     */
    @QtUninvokable
    public final void printToPdf(java.util.function.@StrictNonNull @Nullable Consumer callback){
        java.util.Objects.requireNonNull(callback, "Argument 'callback': null not expected.");
        printToPdf_native_cref_std_function_void_const_QByteArray_ref__(QtJambi_LibraryUtilities.internal.nativeId(this), callback);
    }
    
    @QtUninvokable
    private native void printToPdf_native_cref_std_function_void_const_QByteArray_ref__(long __this__nativeId, java.util.function.Consumer callback);
    
    /**
     * See QWebEngineFrame::runJavaScript(QString,QJSValue)
     * @param script
     * @param callback
     */
    @SuppressWarnings({"exports"})
    public final void runJavaScript(java.lang.@NonNull String script, io.qt.qml.@NonNull QJSValue callback){
        runJavaScript_native_cref_QString_cref_QJSValue(QtJambi_LibraryUtilities.internal.nativeId(this), script, QtJambi_LibraryUtilities.internal.checkedNativeId(callback));
    }
    
    private native void runJavaScript_native_cref_QString_cref_QJSValue(long __this__nativeId, java.lang.String script, long callback);
    
    /**
     * See QWebEngineFrame::runJavaScript(QString,quint32)
     * @param script
     * @param worldId
     */
    public final void runJavaScript(java.lang.@NonNull String script, int worldId){
        runJavaScript_native_cref_QString_quint32(QtJambi_LibraryUtilities.internal.nativeId(this), script, worldId);
    }
    
    private native void runJavaScript_native_cref_QString_quint32(long __this__nativeId, java.lang.String script, int worldId);
    
    /**
     * See QWebEngineFrame::runJavaScript(QString,quint32,QJSValue)
     * @param script
     * @param worldId
     * @param callback
     */
    @SuppressWarnings({"exports"})
    public final void runJavaScript(java.lang.@NonNull String script, int worldId, io.qt.qml.@NonNull QJSValue callback){
        runJavaScript_native_cref_QString_quint32_cref_QJSValue(QtJambi_LibraryUtilities.internal.nativeId(this), script, worldId, QtJambi_LibraryUtilities.internal.checkedNativeId(callback));
    }
    
    private native void runJavaScript_native_cref_QString_quint32_cref_QJSValue(long __this__nativeId, java.lang.String script, int worldId, long callback);
    
    /**
     * See QWebEngineFrame::runJavaScript(const QString&,quint32,const std::function<void(const QVariant&)>&)
     * @param script
     * @param worldId
     * @param callback
     */
    @QtUninvokable
    public final void runJavaScript(java.lang.@NonNull String script, int worldId, java.util.function.@Nullable Consumer<@Nullable Object> callback){
        runJavaScript_native_cref_QString_quint32_cref_std_function_void_const_QVariant_ref__(QtJambi_LibraryUtilities.internal.nativeId(this), script, worldId, callback);
    }
    
    @QtUninvokable
    private native void runJavaScript_native_cref_QString_quint32_cref_std_function_void_const_QVariant_ref__(long __this__nativeId, java.lang.String script, int worldId, java.util.function.Consumer<@Nullable Object> callback);
    
    /**
     * See QWebEngineFrame::runJavaScript(const QString&,const std::function<void(const QVariant&)>&)
     * @param script
     * @param callback
     */
    @QtUninvokable
    public final void runJavaScript(java.lang.@NonNull String script, java.util.function.@Nullable Consumer<@Nullable Object> callback){
        runJavaScript_native_cref_QString_cref_std_function_void_const_QVariant_ref__(QtJambi_LibraryUtilities.internal.nativeId(this), script, callback);
    }
    
    @QtUninvokable
    private native void runJavaScript_native_cref_QString_cref_std_function_void_const_QVariant_ref__(long __this__nativeId, java.lang.String script, java.util.function.Consumer<@Nullable Object> callback);
    
    /**
     * See QWebEngineFrame::size()const
     * @return
     */
    @QtPropertyReader(name="size")
    @QtUninvokable
    public final io.qt.core.@NonNull QSizeF size(){
        return size_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QSizeF size_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineFrame::url()const
     * @return
     */
    @QtPropertyReader(name="url")
    @QtUninvokable
    public final io.qt.core.@NonNull QUrl url(){
        return url_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QUrl url_native_constfct(long __this__nativeId);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    private QWebEngineFrame(QPrivateConstructor p) { super(p); } 
    

    /**
     * See operator==(QWebEngineFrame,QWebEngineFrame)
     */
    @Override
    @QtUninvokable
    public boolean equals(Object other) {
        if (other==null || other instanceof io.qt.webengine.core.QWebEngineFrame) {
            return equals((io.qt.webengine.core.QWebEngineFrame) other);
        }

        return false;
    }

    
    /**
     * Creates and returns a copy of this object.
    See QWebEngineFrame::QWebEngineFrame(QWebEngineFrame)
     */
    @QtUninvokable
    @Override
    public QWebEngineFrame clone() {
        return clone_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    private static native QWebEngineFrame clone_native(long __this_nativeId);
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #htmlName()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final java.lang.@NonNull String getHtmlName() {
        return htmlName();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #name()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final java.lang.@NonNull String getName() {
        return name();
    }
    
    /**
     * Overloaded function for {@link #printToPdf(io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void printToPdf(io.qt.qml.QJSValue.@NonNull SpecialValue callback) {
        printToPdf(new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #printToPdf(io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void printToPdf(boolean callback) {
        printToPdf(new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #printToPdf(io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void printToPdf(int callback) {
        printToPdf(new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #printToPdf(io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void printToPdf(double callback) {
        printToPdf(new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #runJavaScript(java.lang.String, io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void runJavaScript(java.lang.@NonNull String script, io.qt.qml.QJSValue.@NonNull SpecialValue callback) {
        runJavaScript(script, new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #runJavaScript(java.lang.String, io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void runJavaScript(java.lang.@NonNull String script, boolean callback) {
        runJavaScript(script, new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #runJavaScript(java.lang.String, io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void runJavaScript(java.lang.@NonNull String script, double callback) {
        runJavaScript(script, new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #runJavaScript(java.lang.String, io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void runJavaScript(java.lang.@NonNull String script, java.lang.@NonNull String callback) {
        runJavaScript(script, new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #runJavaScript(java.lang.String, int)}
     *  with worldId = 0.
     */
    public final void runJavaScript(java.lang.@NonNull String script) {
        runJavaScript(script, (int)0);
    }
    
    /**
     * Overloaded function for {@link #runJavaScript(java.lang.String, int, io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void runJavaScript(java.lang.@NonNull String script, int worldId, io.qt.qml.QJSValue.@NonNull SpecialValue callback) {
        runJavaScript(script, worldId, new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #runJavaScript(java.lang.String, int, io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void runJavaScript(java.lang.@NonNull String script, int worldId, boolean callback) {
        runJavaScript(script, worldId, new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #runJavaScript(java.lang.String, int, io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void runJavaScript(java.lang.@NonNull String script, int worldId, int callback) {
        runJavaScript(script, worldId, new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #runJavaScript(java.lang.String, int, io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void runJavaScript(java.lang.@NonNull String script, int worldId, double callback) {
        runJavaScript(script, worldId, new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * Overloaded function for {@link #runJavaScript(java.lang.String, int, io.qt.qml.QJSValue)}.
     */
    @SuppressWarnings({"exports"})
    public final void runJavaScript(java.lang.@NonNull String script, int worldId, java.lang.@NonNull String callback) {
        runJavaScript(script, worldId, new io.qt.qml.QJSValue(callback));
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #size()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.core.@NonNull QSizeF getSize() {
        return size();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #url()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.core.@NonNull QUrl getUrl() {
        return url();
    }
}