BeagleClient/QueryProxy.cs

   1 //
   2 // QueryProxy.cs
   3 //
   4 // Copyright (C) 2004 Novell, Inc.
   5 //
   6
   7 //
   8 // Permission is hereby granted, free of charge, to any person obtaining a
   9 // copy of this software and associated documentation files (the "Software"),
  10 // to deal in the Software without restriction, including without limitation
  11 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12 // and/or sell copies of the Software, and to permit persons to whom the
  13 // Software is furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in
  16 // all copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24 // DEALINGS IN THE SOFTWARE.
  25 //
  26
  27 namespace Beagle
  28 {
  29         using System.Collections;
  30         using DBus;
  31
  32         public enum QueryDomain {
  33                 Local        = 1,
  34                 Neighborhood = 2,
  35                 Global       = 4
  36         }
  37
  38         [Interface ("com.novell.Beagle.Query")]
  39         public abstract class QueryProxy {
  40
  41                 [Method]
  42                 public abstract void AddText (string str);
  43
  44                 [Method]
  45                 public abstract void AddTextRaw (string str);
  46
  47                 [Method]
  48                 public abstract string GetTextBlob ();
  49
  50                 [Method]
  51                 public abstract void AddMimeType (string type);
  52
  53                 [Method]
  54                 public abstract void AddHitType (string type);
  55
  56                 [Method]
  57                 public abstract void AddSource (string source);
  58
  59                 [Method]
  60                 public abstract void AddDomain (QueryDomain d);
  61
  62                 [Method]
  63                 public abstract void RemoveDomain (QueryDomain d);
  64
  65                 [Method]
  66                 public abstract void Start ();
  67
  68                 [Method]
  69                 public abstract void Cancel ();
  70
  71                 [Method]
  72                 public abstract void CloseQuery ();
  73
  74                 [Method]
  75                 public abstract string GetSnippetFromUriString (string uri_string);
  76
  77                 public delegate void StartedHandler (QueryProxy sender);
  78                 [Signal]
  79                 public virtual event StartedHandler StartedEvent;
  80
  81                 public delegate void HitsAddedAsBinaryHandler (QueryProxy sender, string hits);
  82                 [Signal]
  83                 public virtual event HitsAddedAsBinaryHandler HitsAddedAsBinaryEvent;
  84
  85                 public delegate void HitsSubtractedAsStringHandler (QueryProxy sender, string uriList);
  86                 [Signal]
  87                 public virtual event HitsSubtractedAsStringHandler HitsSubtractedAsStringEvent;
  88
  89                 public delegate void CancelledHandler (QueryProxy sender);
  90                 [Signal]
  91                 public virtual event CancelledHandler CancelledEvent;
  92
  93                 public delegate void FinishedHandler (QueryProxy source);
  94                 [Signal]
  95                 public virtual event FinishedHandler FinishedEvent;
  96         }
  97 }