/*
 * Geopaparazzi - Digital field mapping on Android based devices
 * Copyright (C) 2016  HydroloGIS (www.hydrologis.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package eu.geopaparazzi.library.plugin.types;


import android.content.Intent;

import eu.geopaparazzi.library.util.IActivitySupporter;

/**
 * MenuEntry extension type. An extension that returns a label and icon
 *
 * @author Cesar Martinez Izquierdo  (www.scolab.es)
 */
public interface IMenuEntry {
    /**
     * Returns the text to show in the menu entry
     */
    String getLabel();

    /**
     * Returns the icon
     */
    byte[] getIcon();

    /**
     * This is invoked when the entry is clicked. Use this method to
     * implement the action to perform by the entry (e.g. opening an
     * activity, showing a dialog, etc)
     */
    void onClick(IActivitySupporter clickActivityStarter);

    /**
     * Gets the order in which the entry should be placed. The application installing the
     * menu entries are free to use or ignore this proposed order.
     * Zero will be the top-most menu entry and 500 is the default value.
     *
     * @return An integer number >= 0, where 0 means the top most
     * item. Negative numbers means no particular order.
     */
    int getOrder();

    /**
     * Setter for a request code to be used.
     *
     * @param requestCode the code.
     */
    void setRequestCode(int requestCode);

    /**
     * If an activity result is necessary, this can be launched on it.
     */
    void onActivityResultExecute(int requestCode, int resultCode, Intent data);

}