libbeagle/beagle/beagle-queryable-status.h

   1 /*
   2  * beagle-queryable-status.h
   3  *
   4  * Copyright (C) 2006 Debajyoti Bera <dbera.web@gmail.com>
   5  *
   6  */
   7
   8 /*
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  24  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  25  * DEALINGS IN THE SOFTWARE.
  26  */
  27
  28 #ifndef __BEAGLE_QUERYABLE_STATUS_H
  29 #define __BEAGLE_QUERYABLE_STATUS_H
  30
  31 #include <glib-object.h>
  32
  33 typedef struct _BeagleQueryableStatus BeagleQueryableStatus;
  34
  35 typedef enum {
  36         BEAGLE_QUERYABLE_STATE_NA, /* Not Applicable */
  37         BEAGLE_QUERYABLE_STATE_IDLE,
  38         BEAGLE_QUERYABLE_STATE_CRAWLING,
  39         BEAGLE_QUERYABLE_STATE_INDEXING,
  40         BEAGLE_QUERYABLE_STATE_FLUSHING
  41 } BeagleQueryableState;
  42
  43 BeagleQueryableStatus * beagle_queryable_status_ref (BeagleQueryableStatus *status);
  44 void beagle_queryable_status_unref (BeagleQueryableStatus *status);
  45
  46 G_CONST_RETURN char *
  47 beagle_queryable_status_get_name (BeagleQueryableStatus *status);
  48
  49 int
  50 beagle_queryable_status_get_item_count (BeagleQueryableStatus *status);
  51
  52 BeagleQueryableState
  53 beagle_queryable_status_get_state (BeagleQueryableStatus *status);
  54
  55 int
  56 beagle_queryable_status_get_progress_percent (BeagleQueryableStatus *status);
  57
  58 gboolean
  59 beagle_queryable_status_get_is_indexing (BeagleQueryableStatus *status);
  60
  61 #endif /* __BEAGLE_QUERYABLE_STATUS_H */
  62