include/core/jukebox.hpp

   1 #ifndef _jukebox__hpp__included__
   2 #define _jukebox__hpp__included__
   3
   4 #include <functional>
   5 #include <cstdlib>
   6 #include <string>
   7
   8 namespace settingvar { class group; }
   9
  10 class save_jukebox_listener;
  11
  12 /**
  13  * Save jukebox.
  14  */
  15 class save_jukebox
  16 {
  17 public:
  18 /**
  19  * Ctor.
  20  */
  21         save_jukebox(settingvar::group& _settings);
  22 /**
  23  * Dtor.
  24  */
  25         ~save_jukebox();
  26 /**
  27  * Get current slot.
  28  *
  29  * Throws std::runtime_exception: No slot selected.
  30  */
  31         size_t get_slot();
  32 /**
  33  * Set current slot.
  34  *
  35  * Parameter slot: The slot to select.
  36  * Throws std::runtime_exception: Slot out of range.
  37  */
  38         void set_slot(size_t slot);
  39 /**
  40  * Cycle next slot.
  41  *
  42  * Throws std::runtime_exception: No slot selected.
  43  */
  44         void cycle_next();
  45 /**
  46  * Cycle previous slot.
  47  *
  48  * Throws std::runtime_exception: No slot selected.
  49  */
  50         void cycle_prev();
  51 /**
  52  * Get save as binary flag.
  53  */
  54         bool save_binary();
  55 /**
  56  * Get name of current jukebox slot.
  57  *
  58  * Throws std::runtime_exception: No slot selected.
  59  */
  60         std::string get_slot_name();
  61 /**
  62  * Set size of jukebox.
  63  *
  64  * Parameter size: The new size.
  65  */
  66         void set_size(size_t size);
  67 /**
  68  * Set update function.
  69  */
  70         void set_update(std::function<void()> _update);
  71 /**
  72  * Unset update function.
  73  */
  74         void unset_update();
  75 private:
  76         settingvar::group& settings;
  77         size_t current_slot;
  78         size_t current_size;
  79         std::function<void()> update;
  80         save_jukebox_listener* listener;
  81 };
  82
  83 #endif