menu.h

Go to the documentation of this file.

//
// Copyright RIME Developers
// Distributed under the BSD License
//
// 2011-05-29 GONG Chen <chen.sst@gmail.com>
//
#ifndef RIME_MENU_H_
#define RIME_MENU_H_
 
#include <rime_api.h>
#include <rime/candidate.h>
#include <rime/common.h>
 
namespace rime {
 
struct Page {
  int page_size = 0;
  int page_no = 0;
  bool is_last_page = false;
  CandidateList candidates;
};
 
class Filter;
class MergedTranslation;
class Translation;
 
class Menu {
 public:
  RIME_DLL Menu();
 
  RIME_DLL void AddTranslation(an<Translation> translation);
  void AddFilter(Filter* filter);
 
  RIME_DLL size_t Prepare(size_t candidate_count);
  RIME_DLL Page* CreatePage(size_t page_size, size_t page_no);
  an<Candidate> GetCandidateAt(size_t index);
 
  // CAVEAT: returns the number of candidates currently obtained,
  // rather than the total number of available candidates.
  size_t candidate_count() const { return candidates_.size(); }
 
  bool empty() const;
 
 private:
  an<MergedTranslation> merged_;
  an<Translation> result_;
  CandidateList candidates_;
};
 
}  // namespace rime
 
#endif  // RIME_MENU_H_