main/src/addins/MonoDevelop.DesignerSupport/MonoDevelop.DesignerSupport.Toolbox/IToolboxProvider.cs

   1 //
   2 // IToolbox(Default|Dynamic)Provider.cs: Interface for extensions that
   3 //   provide toolbox items.
   4 //
   5 // Authors:
   6 //   Michael Hutchinson <m.j.hutchinson@gmail.com>
   7 //
   8 // Copyright (C) 2006 Michael Hutchinson
   9 //
  10 //
  11 // This source code is licenced under The MIT License:
  12 //
  13 // Permission is hereby granted, free of charge, to any person obtaining
  14 // a copy of this software and associated documentation files (the
  15 // "Software"), to deal in the Software without restriction, including
  16 // without limitation the rights to use, copy, modify, merge, publish,
  17 // distribute, sublicense, and/or sell copies of the Software, and to
  18 // permit persons to whom the Software is furnished to do so, subject to
  19 // the following conditions:
  20 //
  21 // The above copyright notice and this permission notice shall be
  22 // included in all copies or substantial portions of the Software.
  23 //
  24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 //
  32
  33 using System;
  34 using System.Collections.Generic;
  35
  36 namespace MonoDevelop.DesignerSupport.Toolbox
  37 {
  38
  39         //Used to fetch or generate the default toolbox items at the beginning of each MD session
  40         public interface IToolboxDefaultProvider
  41         {
  42                 // It should return a list of items to be added by default to the toolbox
  43                 IEnumerable<ItemToolboxNode> GetDefaultItems ();
  44
  45                 // It should return a list of files which contains items to be added by default
  46                 // to the toolbox (all items in the files will be added).
  47                 IEnumerable<string> GetDefaultFiles ();
  48         }
  49
  50         //Can provide dynamic toolbox items for a specific consumer.
  51         public interface IToolboxDynamicProvider
  52         {
  53                 //This method will be called each time the consumer changes. Return null if not
  54                 //returning any items for a specific consumer.
  55                 IEnumerable<ItemToolboxNode> GetDynamicItems (IToolboxConsumer consumer);
  56
  57                 event EventHandler ItemsChanged;
  58         }
  59 }