doc/ui_efl_util_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_UI_EFL_UTIL_DOC_H__
  19 #define __TIZEN_UI_EFL_UTIL_DOC_H__
  20
  21 /**
  22  * @ingroup CAPI_UI_FRAMEWORK
  23  * @defgroup CAPI_EFL_UTIL_MODULE EFL UTIL
  24  * @brief
  25  *
  26  * @section CAPI_EFL_UTIL_MODULE_HEADER Required Header
  27  *   \#include <efl_util.h>
  28  *
  29  * @section CAPI_EFL_UTIL_MODULE_OVERVIEW Overview
  30  * The EFL UTIL API provides functions to get the level of given notification windows
  31  * and to change the notification window levels with the given values.
  32  *
  33  * The notification window level is used in ordering the notification windows.
  34  * The notification window which is set to #EFL_UTIL_NOTIFICATION_LEVEL_2 will be
  35  * placed above the window which is set to #EFL_UTIL_NOTIFICATION_LEVEL_1.
  36  * If there are notification windows that have the same levels, the latest created
  37  * notification window is placed on top of the other window.
  38  *
  39  */
  40
  41 #endif /* __TIZEN_UI_EFL_UTIL_DOC_H__ */