git.maemo.org Git - hildon/blob - src/hildon-input-mode-hint.h

   1 /*
   2  * This file is a part of hildon
   3  *
   4  * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
   5  *
   6  * Contact: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; version 2.1 of
  11  * the License.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  *
  23  */
  24
  25 #ifndef                                         __HILDON_INPUT_MODE_HINT_H__
  26 #define                                         __HILDON_INPUT_MODE_HINT_H__
  27
  28 G_BEGIN_DECLS
  29
  30 /* Hildon wrapper for setting the input mode in a GtkEntry
  31  * Usage: g_object_set(G_OBJECT(entry), HILDON_INPUT_MODE_HINT, HILDON_INPUT_MODE_HINT_HEXA, NULL);
  32  */
  33 #define                                         HILDON_INPUT_MODE_HINT "input-mode"
  34
  35 /* Hildon wrapper for setting the autocapitalization in text widgets.
  36  * Usage: g_object_set(G_OBJECT(entry), HILDON_AUTOCAP, FALSE, NULL);
  37  */
  38 #define                                         HILDON_AUTOCAP "autocap"
  39
  40 /**
  41  * HildonInputModeHint:
  42  * @HILDON_INPUT_MODE_HINT_ALPHANUMERICSPECIAL: accept all characters.
  43  * @HILDON_INPUT_MODE_HINT_NUMERIC: accept only NUMERIC characters.
  44  * @HILDON_INPUT_MODE_HINT_ALPHA: accept only ALPHA characters
  45  * @HILDON_INPUT_MODE_HINT_NUMERICSPECIAL: accept only NUMERIC and SPECIAL
  46  * @HILDON_INPUT_MODE_HINT_ALPHASPECIAL: accept only ALPHA and SPECIAL
  47  * @HILDON_INPUT_MODE_HINT_ALPHANUMERIC: accept only ALPHA and NUMERIC
  48  * @HILDON_INPUT_MODE_HINT_HEXA: accept only HEXA
  49  * @HILDON_INPUT_MODE_HINT_HEXASPECIAL: accept only HEXA and SPECIAL
  50  * @HILDON_INPUT_MODE_HINT_TELE: accept only TELEPHONE
  51  * @HILDON_INPUT_MODE_HINT_TELESPECIAL: accept only TELEPHONE and SPECIAL
  52  *
  53  * Keys to set the mode in a GtkEntry widget into ALPHANUMERIC or NUMERIC mode.
  54  * Note that this is only a hint; it only shows VKB with specified layout.
  55  * Use it by calling 'g_object_set(G_OBJECT(entry), "input-mode", HILDON_INPUT_MODE_HINT_NUMERIC, NULL);'.
  56  * This should not be used to as the only method of verifying user input.
  57  */
  58 typedef enum
  59 {
  60     HILDON_INPUT_MODE_HINT_ALPHANUMERICSPECIAL = 0,
  61     HILDON_INPUT_MODE_HINT_NUMERIC,
  62     HILDON_INPUT_MODE_HINT_ALPHA,
  63     HILDON_INPUT_MODE_HINT_NUMERICSPECIAL,
  64     HILDON_INPUT_MODE_HINT_ALPHASPECIAL,
  65     HILDON_INPUT_MODE_HINT_ALPHANUMERIC,
  66     HILDON_INPUT_MODE_HINT_HEXA,
  67     HILDON_INPUT_MODE_HINT_HEXASPECIAL,
  68     HILDON_INPUT_MODE_HINT_TELE,
  69     HILDON_INPUT_MODE_HINT_TELESPECIAL
  70
  71 } HildonInputModeHint;
  72
  73 G_END_DECLS
  74
  75 #endif                                          /* __HILDON_INPUT_MODE_HINT_H__ */