1 // Copyright 2010-2018, Google Inc.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 //     * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 //     * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
13 // distribution.
14 //     * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
17 //
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 
30 #ifndef MOZC_UNIX_IBUS_CANDIDATE_WINDOW_HANDLER_INTERFACE_H_
31 #define MOZC_UNIX_IBUS_CANDIDATE_WINDOW_HANDLER_INTERFACE_H_
32 
33 #include <string>
34 
35 #include "base/port.h"
36 #include "unix/ibus/ibus_header.h"
37 
38 namespace mozc {
39 namespace commands {
40 class Output;
41 }  // namespace commands
42 namespace ibus {
43 
44 class CandidateWindowHandlerInterface {
45  public:
CandidateWindowHandlerInterface()46   CandidateWindowHandlerInterface() {}
~CandidateWindowHandlerInterface()47   virtual ~CandidateWindowHandlerInterface() {}
48 
49   // Updates candidate state. This function also shows or hides candidate window
50   // based on output argument.
51   virtual void Update(IBusEngine *engine,
52                       const commands::Output &output) = 0;
53 
54   // Updates candidate state. This function also shows or hides candidate window
55   // based on the last |Update| call.
56   virtual void UpdateCursorRect(IBusEngine *engine) = 0;
57 
58   // Hides candidate window.
59   virtual void Hide(IBusEngine *engine) = 0;
60 
61   // Shows candidate window.
62   virtual void Show(IBusEngine *engine) = 0;
63 
64   // Following methods handle property-changed events relevant to ibus-panel.
65   // |custom_font_description| should be a string representation of
66   // PangoFontDescription.
67   // http://developer.gnome.org/pango/stable/pango-Fonts.html#pango-font-description-from-string
68   virtual void OnIBusCustomFontDescriptionChanged(
69       const string &custom_font_description) = 0;
70   virtual void OnIBusUseCustomFontDescriptionChanged(
71       bool use_custom_font_description) = 0;
72 
73  private:
74   DISALLOW_COPY_AND_ASSIGN(CandidateWindowHandlerInterface);
75 };
76 
77 }  // namespace ibus
78 }  // namespace mozc
79 #endif  // MOZC_UNIX_IBUS_CANDIDATE_WINDOW_HANDLER_INTERFACE_H_
80