← Back to branch summary

~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/xwt/Xwt/Xwt.Backends/IListStoreBackend.cs

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
Import upstream version 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
external/xwt/Xwt/Xwt.Backends/IListStoreBackend.cs
 
1
// 
 
2
// IListStoreBackend.cs
 
3
//  
 
4
// Author:
 
5
//       Lluis Sanchez <lluis@xamarin.com>
 
6
//       Eric Maupin <ermau@xamarin.com>
 
7
// 
 
8
// Copyright (c) 2011-2012 Xamarin, Inc.
 
9
// 
 
10
// Permission is hereby granted, free of charge, to any person obtaining a copy
 
11
// of this software and associated documentation files (the "Software"), to deal
 
12
// in the Software without restriction, including without limitation the rights
 
13
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 
14
// copies of the Software, and to permit persons to whom the Software is
 
15
// furnished to do so, subject to the following conditions:
 
16
// 
 
17
// The above copyright notice and this permission notice shall be included in
 
18
// all copies or substantial portions of the Software.
 
19
// 
 
20
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
21
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
22
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 
23
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 
24
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 
25
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 
26
// THE SOFTWARE.
 
27
 
 
28
using System;
 
29
 
 
30
namespace Xwt.Backends
 
31
{
 
32
        /// <summary>
 
33
        /// A ListStore backend.
 
34
        /// </summary>
 
35
        public interface IListStoreBackend: IListDataSource, IBackend
 
36
        {
 
37
                // WARNING: You don't need to implement this backend.
 
38
                // Xwt provides a default implementation.
 
39
                // You only need to implement it if the underlying widget
 
40
                // toolkit has its own list store implementation which
 
41
                // can be plugged into a ListView or ComboBox
 
42
                
 
43
                /// <summary>
 
44
                /// Initializes the backend with the given <paramref name="columnTypes"/>.
 
45
                /// </summary>
 
46
                /// <param name="columnTypes">The data types of the columns for this list store.</param>
 
47
                /// <exception cref="ArgumentNullException"><paramref name="columnTypes"/> is <c>null</c>.</exception>
 
48
                void Initialize (Type[] columnTypes);
 
49
                
 
50
                /// <summary>
 
51
                /// Adds a new row and returns the index.
 
52
                /// </summary>
 
53
                /// <returns>The index of the newly added row.</returns>
 
54
                int AddRow ();
 
55
                
 
56
                /// <summary>
 
57
                /// Inserts a new row after <paramref name="row"/> and returns the index.
 
58
                /// </summary>
 
59
                /// <param name="row">The index of the row to insert a new row after.</param>
 
60
                /// <returns>The index of the newly added row.</returns>
 
61
                /// <exception cref="ArgumentOutOfRangeException">
 
62
                /// <paramref name="row"/> is &gt;= <see cref="IListDataSource.RowCount" />
 
63
                /// </exception>
 
64
                int InsertRowAfter (int row);
 
65
                
 
66
                /// <summary>
 
67
                /// Inserts a new row before <paramref name="row"/> and returns the index.
 
68
                /// </summary>
 
69
                /// <param name="row">The index of the row to insert a new row before.</param>
 
70
                /// <returns>The index of the newly added row.</returns>
 
71
                /// <exception cref="ArgumentOutOfRangeException">
 
72
                /// <paramref name="row"/> is &gt;= <see cref="IListDataSource.RowCount" />
 
73
                /// </exception>
 
74
                int InsertRowBefore (int row);
 
75
                
 
76
                /// <summary>
 
77
                /// Removes a row at the given index (<paramref name="row"/>).
 
78
                /// </summary>
 
79
                /// <param name="row">The index of the row to remove.</param>
 
80
                /// <exception cref="ArgumentOutOfRangeException">
 
81
                /// <paramref name="row"/> is &gt;= <see cref="IListDataSource.RowCount" />
 
82
                /// </exception>
 
83
                void RemoveRow (int row);
 
84
 
 
85
                /// <summary>
 
86
                /// Removes all rows
 
87
                /// </summary>
 
88
                void Clear ();
 
89
        }
 
90
}
 
91