1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

// Copyright (c) 2007-2009 Google Inc.
// Copyright (c) 2006-2007 Jaiku Ltd.
// Copyright (c) 2002-2006 Mika Raento and Renaud Petit
//
// This software is licensed at your choice under either 1 or 2 below.
//
// 1. MIT License
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
// 2. Gnu General Public license 2.0
//
// 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 2
// 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, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
//
// This file is part of the JaikuEngine mobile client.

#ifndef JAIKU_KEYEVENTS_CLIENT_H__
#define JAIKU_KEYEVENTS_CLIENT_H__

// System includes.
#include <e32property.h>
#include <w32std.h>

// Local includes.
#include "keyevents/client_server_constants.h"

// Forward declarations.
class RKeyEventsAnim;

// The CKeyEventsClient class provides a method to get notifications when the
// user presses a key. An RProperty passed to OpenNotificationPropertyL will be
// opened on an integer key that increments for each key down.
//
// The class wraps the keyevents client-server functionality and exposes just
// the property for notifications.  Instantiating it will instantiate all the
// necessary objects for the property to get updated.
//
// TODO(mikie): split into interface+factory method and implementation

class CKeyEventsClient : public CBase {
 public:
  IMPORT_C static CKeyEventsClient* NewL(const TUid& category_uid, TUint key_id,
    RWsSession* ws_io, RWindowGroup* window_group_io);
  IMPORT_C void OpenNotificationPropertyL(RProperty* property_out);
  IMPORT_C virtual ~CKeyEventsClient();
 private:
  CKeyEventsClient(RWsSession* ws_io);
  void ConstructL(const TUid& category_uid, TUint key_id,
                  RWindowGroup* window_group_io);

  RAnimDll keyevents_dll_;
  RKeyEventsAnim *keyevents_;
  RWindow window_;

  TKeyServerArgs property_definition_;
  TPckg<TKeyServerArgs> property_definition_pckg_;
};

#endif  // JAIKU_KEYEVENTS_CLIENT_H__