diff options
Diffstat (limited to 'src/actions/action.vala')
-rw-r--r-- | src/actions/action.vala | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/src/actions/action.vala b/src/actions/action.vala new file mode 100644 index 0000000..ceed357 --- /dev/null +++ b/src/actions/action.vala @@ -0,0 +1,77 @@ +/* +Copyright (c) 2011 by Simon Schneegans + +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/>. +*/ + +namespace GnomePie { + +///////////////////////////////////////////////////////////////////////// +/// A base class for actions, which are executed when the user +/// activates a pie's slice. +///////////////////////////////////////////////////////////////////////// + +public abstract class Action : GLib.Object { + + ///////////////////////////////////////////////////////////////////// + /// The command which gets executed when user activates the Slice. + /// It may be anything but has to be representable with a string. + ///////////////////////////////////////////////////////////////////// + + public abstract string real_command { get; construct set; } + + ///////////////////////////////////////////////////////////////////// + /// The command displayed to the user. It should be a bit more + /// beautiful than the real_command. + ///////////////////////////////////////////////////////////////////// + + public abstract string display_command { get; } + + ///////////////////////////////////////////////////////////////////// + /// The name of the Action. + ///////////////////////////////////////////////////////////////////// + + public virtual string name { get; protected set; } + + ///////////////////////////////////////////////////////////////////// + /// The name of the icon of this Action. It should be in the users + /// current icon theme. + ///////////////////////////////////////////////////////////////////// + + public virtual string icon { get; protected set; } + + ///////////////////////////////////////////////////////////////////// + /// True, if this Action is the quickAction of the associated Pie. + /// The quickAction of a Pie gets executed when the users clicks on + /// the center of a Pie. + ///////////////////////////////////////////////////////////////////// + + public virtual bool is_quick_action { get; protected set; } + + ///////////////////////////////////////////////////////////////////// + /// C'tor, initializes all members. + ///////////////////////////////////////////////////////////////////// + + public Action(string name, string icon, bool is_quick_action) { + GLib.Object(name : name, icon : icon, is_quick_action : is_quick_action); + } + + ///////////////////////////////////////////////////////////////////// + /// This one is called, when the user activates the Slice. + ///////////////////////////////////////////////////////////////////// + + public abstract void activate(); +} + +} |