diff options
Diffstat (limited to 'src/jrummikub/view/IQuitWarningPanel.java')
| -rw-r--r-- | src/jrummikub/view/IQuitWarningPanel.java | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/src/jrummikub/view/IQuitWarningPanel.java b/src/jrummikub/view/IQuitWarningPanel.java index b1f4123..34d9e07 100644 --- a/src/jrummikub/view/IQuitWarningPanel.java +++ b/src/jrummikub/view/IQuitWarningPanel.java @@ -2,8 +2,14 @@ package jrummikub.view; import jrummikub.util.IEvent; +/** + * Warning panel shown to if the emitted event would cancel the current game + */ public interface IQuitWarningPanel { + /** + * Enum summarizing the different events invoking the quit warning panel + */ public enum QuitMode { /** */ DEFAULT, @@ -13,12 +19,33 @@ public interface IQuitWarningPanel { QUIT_GAME } + /** + * Is emitted if the user is positive about quitting + * + * @return the event + */ public IEvent getQuitEvent(); + /** + * Is emitted if the user selected quit by mistake + * + * @return the event + */ public IEvent getCancelEvent(); + /** + * Sets the panel according to the event which invoked it + * + * @param mode + * the invoking event type + */ public void setMode(QuitMode mode); + /** + * Getter for quit mode + * + * @return the quit mode + */ public QuitMode getQuitMode(); }
\ No newline at end of file |