dorkbox.systemTray.ui.gtk.GtkBaseMenuItem Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of SystemTray Show documentation
Cross-platform SystemTray support for Swing/AWT, GtkStatusIcon, and AppIndicator on Java 8+
There is a newer version: 4.4
/*
 * Copyright 2021 dorkbox, llc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package dorkbox.systemTray.ui.gtk;

import static dorkbox.jna.linux.Gtk.Gtk2;

import java.io.File;

import com.sun.jna.Pointer;

import dorkbox.jna.linux.GObject;
import dorkbox.jna.linux.GtkEventDispatch;
import dorkbox.systemTray.peer.EntryPeer;

abstract
class GtkBaseMenuItem implements EntryPeer {
    // these are necessary BECAUSE GTK menus look funky when there are some menu entries WITH icons and some WITHOUT
    // This is set from _AppIndicatorNativeTray or _GtkStatusIconNativeTray
    static File transparentIcon = null;
    private volatile boolean hasLegitImage = false; // default is to not have an image assigned

    // these have to be volatile, because they can be changed from any thread
    private volatile Pointer spacerImage;

    // the native GTK component
    protected final Pointer _native;

    GtkBaseMenuItem(final Pointer _native) {
        this._native = _native;
    }

    public
    boolean hasImage() {
        return hasLegitImage;
    }

    void setLegitImage(boolean isLegit) {
        hasLegitImage = isLegit;
    }

    /**
     * always remove a spacer image.
     * 
     * called on the DISPATCH thread
     */
    protected
    void removeSpacerImage() {
        if (spacerImage != null) {
            Gtk2.gtk_container_remove(_native, spacerImage); // will automatically get destroyed if no other references to it
            spacerImage = null;
        }
    }


    /**
     * always add a spacer image.
     * 

     * called on the DISPATCH thread
     */
    protected
    void addSpacerImage() {
        if (spacerImage == null) {
            spacerImage = Gtk2.gtk_image_new_from_file(transparentIcon.getAbsolutePath());
            Gtk2.gtk_image_menu_item_set_image(_native, spacerImage);

            //  must always re-set always-show after setting the image
            Gtk2.gtk_image_menu_item_set_always_show_image(_native, true);
        }
    }



    /**
     * the menu entry looks FUNKY when there are a mis-match of entries WITH and WITHOUT images.
     * This is primarily only with AppIndicators, although not always.
     * 
     * called on the DISPATCH thread
     */
    public
    void setSpacerImage(final boolean everyoneElseHasImages) {
        if (hasLegitImage) {
            // we have a legit icon, so there is nothing else we can do.
            return;
        }

        removeSpacerImage();

        if (everyoneElseHasImages) {
            addSpacerImage();
        }
    }

    // some GTK libraries DO NOT let us add items AFTER the menu has been attached to the indicator.
    // To work around this issue, we destroy then recreate the menu every time something is changed.
    // always on EDT
    void onDeleteMenu(final Pointer parentNative) {
        GObject.g_object_force_floating(_native);  // makes it a floating reference
        Gtk2.gtk_container_remove(parentNative, _native);
    }

    // some GTK libraries DO NOT let us add items AFTER the menu has been attached to the indicator.
    // To work around this issue, we destroy then recreate the menu every time something is changed.
    // always on EDT
    void onCreateMenu(final Pointer parentNative, final boolean hasImagesInMenu) {
        setSpacerImage(hasImagesInMenu);

        // will also get:  gsignal.c:2516: signal 'child-added' is invalid for instance '0x7f1df8244080' of type 'GtkMenu'
        Gtk2.gtk_menu_shell_append(parentNative, _native);
        GObject.g_object_ref_sink(_native);  // undoes "floating"
        // NOTE: We cannot show the menu until AFTER items have been added, otherwise we get GLIB warnings
    }

    @Override
    public
    void remove() {
        GtkEventDispatch.dispatch(()->{
            if (spacerImage != null) {
                Gtk2.gtk_container_remove(_native, spacerImage); // will automatically get destroyed if no other references to it
                spacerImage = null;
            }
        });
    }
}