mirror of
https://github.com/LawnchairLauncher/lawnchair.git
synced 2026-02-15 08:38:20 +00:00
migrate custom widgets in comply with plugin framework
Bug: 139888225 Change-Id: I8a3d0fe2689ad5ba24b19309728bbad0b6287f71
This commit is contained in:
@@ -0,0 +1,88 @@
|
||||
/*
|
||||
* Copyright (C) 2019 The Android Open Source Project
|
||||
*
|
||||
* 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 com.android.systemui.plugins;
|
||||
|
||||
import android.appwidget.AppWidgetHostView;
|
||||
|
||||
import com.android.systemui.plugins.annotations.ProvidesInterface;
|
||||
|
||||
/**
|
||||
* Implement this plugin interface to add a custom widget.
|
||||
*/
|
||||
@ProvidesInterface(action = CustomWidgetPlugin.ACTION, version = CustomWidgetPlugin.VERSION)
|
||||
public interface CustomWidgetPlugin extends Plugin {
|
||||
|
||||
String ACTION = "com.android.systemui.action.PLUGIN_CUSTOM_WIDGET";
|
||||
int VERSION = 1;
|
||||
|
||||
/**
|
||||
* An unique identifier for this widget. Must be a non-negative integer.
|
||||
*/
|
||||
int getProviderId();
|
||||
|
||||
/**
|
||||
* The label to display to the user in the AppWidget picker.
|
||||
*/
|
||||
String getLabel();
|
||||
|
||||
/**
|
||||
* A preview of what the AppWidget will look like after it's configured.
|
||||
* If not supplied, the AppWidget's icon will be used.
|
||||
*/
|
||||
int getPreviewImage();
|
||||
|
||||
/**
|
||||
* The icon to display for this AppWidget in the AppWidget picker. If not supplied in the
|
||||
* xml, the application icon will be used.
|
||||
*/
|
||||
int getIcon();
|
||||
|
||||
/**
|
||||
* The default width of the widget when added to a host, in dp. The widget will get
|
||||
* at least this width, and will often be given more, depending on the host.
|
||||
*/
|
||||
int getSpanX();
|
||||
|
||||
/**
|
||||
* The default height of the widget when added to a host, in dp. The widget will get
|
||||
* at least this height, and will often be given more, depending on the host.
|
||||
*/
|
||||
int getSpanY();
|
||||
|
||||
/**
|
||||
* Minimum width (in dp) which the widget can be resized to. This field has no effect if it
|
||||
* is greater than minWidth or if horizontal resizing isn't enabled.
|
||||
*/
|
||||
int getMinSpanX();
|
||||
|
||||
/**
|
||||
* Minimum height (in dp) which the widget can be resized to. This field has no effect if it
|
||||
* is greater than minHeight or if vertical resizing isn't enabled.
|
||||
*/
|
||||
int getMinSpanY();
|
||||
|
||||
/**
|
||||
* The rules by which a widget can be resized.
|
||||
*/
|
||||
int getResizeMode();
|
||||
|
||||
/**
|
||||
* Notify the plugin that container of the widget has been rendered, where the custom widget
|
||||
* can be attached to.
|
||||
*/
|
||||
void onViewCreated(AppWidgetHostView parent);
|
||||
}
|
||||
Reference in New Issue
Block a user