Add NOEMPTY plugin flag to MoviePilot plugin - don't start empty searches when set
[cinaest] / src / plugin-interface.vala
1 /* This file is part of Cinaest.
2  *
3  * Copyright (C) 2009 Philipp Zabel
4  *
5  * Cinaest is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * Cinaest is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with Cinaest. If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 public abstract class Plugin : Object {
20         public abstract void hello (Gtk.Window window, Osso.Context context);
21
22         public abstract unowned List<MovieSource> get_sources ();
23         public abstract List<MovieAction> get_actions (Movie movie, Gtk.Window window);
24
25         public abstract void settings_dialog (Gtk.Window window);
26
27         public abstract unowned string get_name ();
28 }
29
30 public enum SourceFlags {
31         EDITABLE = 1,
32         ONLINE = 2,
33         RATING = 4,
34         NOEMPTY = 8,
35 }
36
37 public abstract class MovieSource : Object {
38         public abstract bool active { get; set construct; }
39
40         public delegate void ReceiveMovieFunction (SList<Movie> movie);
41
42         public abstract async int get_movies (MovieFilter filter, ReceiveMovieFunction callback, int limit, GLib.Cancellable? cancellable);
43
44         public abstract void add_movie (Movie movie);
45         public abstract void delete_movie (Movie movie);
46
47         public abstract unowned string get_name ();
48
49         public abstract unowned string get_description ();
50
51         public abstract SourceFlags get_flags ();
52 }
53
54 public class MovieAction : Object {
55         public delegate void MovieActionFunc (Movie movie, Gtk.Window window);
56
57         public string name;
58         private MovieActionFunc action;
59         private Movie movie;
60         private Gtk.Window window;
61
62         public MovieAction (string _name, MovieActionFunc _action, Movie _movie, Gtk.Window _window) {
63                 name = _name;
64                 action = _action;
65                 movie = _movie;
66                 window = _window;
67         }
68
69         public void execute () {
70                 action (movie, window);
71         }
72 }