aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework/Interfaces
diff options
context:
space:
mode:
authorSignpostMarv2012-11-04 11:02:21 +0000
committerDiva Canto2012-11-10 08:12:30 -0800
commitd0742cea3ef1fc24fadab66756d1a5c94bcfe171 (patch)
tree1ce182f1ddecbd01462fc66c32563ad57b9247d1 /OpenSim/Region/Framework/Interfaces
parentDocumenting parameters of methods on the IDialogModule interface (diff)
downloadopensim-SC_OLD-d0742cea3ef1fc24fadab66756d1a5c94bcfe171.zip
opensim-SC_OLD-d0742cea3ef1fc24fadab66756d1a5c94bcfe171.tar.gz
opensim-SC_OLD-d0742cea3ef1fc24fadab66756d1a5c94bcfe171.tar.bz2
opensim-SC_OLD-d0742cea3ef1fc24fadab66756d1a5c94bcfe171.tar.xz
80 character-width terminal formatting of IDialogModule interface, removing superfluous whitespace & line-endings.
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces')
-rw-r--r--OpenSim/Region/Framework/Interfaces/IDialogModule.cs51
1 files changed, 28 insertions, 23 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IDialogModule.cs b/OpenSim/Region/Framework/Interfaces/IDialogModule.cs
index d1e9df0..4d35c1c 100644
--- a/OpenSim/Region/Framework/Interfaces/IDialogModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IDialogModule.cs
@@ -33,15 +33,15 @@ namespace OpenSim.Region.Framework.Interfaces
33 public interface IDialogModule 33 public interface IDialogModule
34 { 34 {
35 /// <summary> 35 /// <summary>
36 /// Send a non-modal alert message to a particular user. This can disappear from the user's view after a 36 /// Send a non-modal alert message to a particular user. This can
37 /// small interval. 37 /// disappear from the user's view after a small interval.
38 /// </summary> 38 /// </summary>
39 /// <param name="client"> 39 /// <param name="client">
40 /// IClientAPI object representing the user. 40 /// IClientAPI object representing the user.
41 /// </param> 41 /// </param>
42 /// <param name="message">Message text to send to the user.</param> 42 /// <param name="message">Message text to send to the user.</param>
43 void SendAlertToUser(IClientAPI client, string message); 43 void SendAlertToUser(IClientAPI client, string message);
44 44
45 /// <summary> 45 /// <summary>
46 /// Send an alert message to a particular user. 46 /// Send an alert message to a particular user.
47 /// </summary> 47 /// </summary>
@@ -51,14 +51,14 @@ namespace OpenSim.Region.Framework.Interfaces
51 /// <param name="message">Message text to send to the user.</param> 51 /// <param name="message">Message text to send to the user.</param>
52 /// <param name="modal">Flag to control modality.</param> 52 /// <param name="modal">Flag to control modality.</param>
53 void SendAlertToUser(IClientAPI client, string message, bool modal); 53 void SendAlertToUser(IClientAPI client, string message, bool modal);
54 54
55 /// <summary> 55 /// <summary>
56 /// Send a non-modal alert message to a particular user. 56 /// Send a non-modal alert message to a particular user.
57 /// </summary> 57 /// </summary>
58 /// <param name="agentID">UUID of agent representing the user.</param> 58 /// <param name="agentID">UUID of agent representing the user.</param>
59 /// <param name="message">Message text to send to the user.</param> 59 /// <param name="message">Message text to send to the user.</param>
60 void SendAlertToUser(UUID agentID, string message); 60 void SendAlertToUser(UUID agentID, string message);
61 61
62 /// <summary> 62 /// <summary>
63 /// Send an alert message to a particular user. 63 /// Send an alert message to a particular user.
64 /// </summary> 64 /// </summary>
@@ -66,7 +66,7 @@ namespace OpenSim.Region.Framework.Interfaces
66 /// <param name="message">Message text to send to the user.</param> 66 /// <param name="message">Message text to send to the user.</param>
67 /// <param name="modal">Flag to control modality.</param> 67 /// <param name="modal">Flag to control modality.</param>
68 void SendAlertToUser(UUID agentID, string message, bool modal); 68 void SendAlertToUser(UUID agentID, string message, bool modal);
69 69
70 /// <summary> 70 /// <summary>
71 /// Send an alert message to a particular user. 71 /// Send an alert message to a particular user.
72 /// </summary> 72 /// </summary>
@@ -74,14 +74,15 @@ namespace OpenSim.Region.Framework.Interfaces
74 /// <param name="lastName">Account last name</param> 74 /// <param name="lastName">Account last name</param>
75 /// <param name="message">Message text to send to the user.</param> 75 /// <param name="message">Message text to send to the user.</param>
76 /// <param name="modal">Flag to control modality.</param> 76 /// <param name="modal">Flag to control modality.</param>
77 void SendAlertToUser(string firstName, string lastName, string message, bool modal); 77 void SendAlertToUser(string firstName, string lastName,
78 78 string message, bool modal);
79
79 /// <summary> 80 /// <summary>
80 /// Send an alert message to all users in the scene. 81 /// Send an alert message to all users in the scene.
81 /// </summary> 82 /// </summary>
82 /// <param name="message">Message text to send to all users.</param> 83 /// <param name="message">Message text to send to all users.</param>
83 void SendGeneralAlert(string message); 84 void SendGeneralAlert(string message);
84 85
85 /// <summary> 86 /// <summary>
86 /// Send a dialog box to a particular user. 87 /// Send a dialog box to a particular user.
87 /// </summary> 88 /// </summary>
@@ -105,10 +106,10 @@ namespace OpenSim.Region.Framework.Interfaces
105 /// Channel on which the selected button text should be broadcast. 106 /// Channel on which the selected button text should be broadcast.
106 /// </param> 107 /// </param>
107 /// <param name="buttonlabels">Dialog button text.</param> 108 /// <param name="buttonlabels">Dialog button text.</param>
108 void SendDialogToUser( 109 void SendDialogToUser(UUID avatarID, string objectName, UUID objectID,
109 UUID avatarID, string objectName, UUID objectID, UUID ownerID, 110 UUID ownerID, string message, UUID textureID, int ch,
110 string message, UUID textureID, int ch, string[] buttonlabels); 111 string[] buttonlabels);
111 112
112 /// <summary> 113 /// <summary>
113 /// Send a url to a particular user. 114 /// Send a url to a particular user.
114 /// </summary> 115 /// </summary>
@@ -129,21 +130,24 @@ namespace OpenSim.Region.Framework.Interfaces
129 /// </param> 130 /// </param>
130 /// <param name="message">Message text to send to the user.</param> 131 /// <param name="message">Message text to send to the user.</param>
131 /// <param name="url">Url to send to the user.</param> 132 /// <param name="url">Url to send to the user.</param>
132 void SendUrlToUser( 133 void SendUrlToUser(UUID avatarID, string objectName, UUID objectID,
133 UUID avatarID, string objectName, UUID objectID, UUID ownerID, bool groupOwned, string message, string url); 134 UUID ownerID, bool groupOwned, string message, string url);
134 135
135 /// <summary> 136 /// <summary>
136 /// Send a notification to all users in the scene. This notification should remain around until the 137 /// Send a notification to all users in the scene. This notification
137 /// user explicitly dismisses it. 138 /// should remain around until the user explicitly dismisses it.
138 /// </summary> 139 /// </summary>
139 /// <remarks> 140 /// <remarks>
140 /// On the Linden Labs Second Client (as of 1.21), this is a big blue box message on the upper right of the 141 /// On the Linden Labs Second Client (as of 1.21), this is a big blue
141 /// screen. 142 /// box message on the upper right of the screen.
142 /// </remarks> 143 /// </remarks>
143 /// <param name="fromAvatarID">The user sending the message</param> 144 /// <param name="fromAvatarID">The user sending the message</param>
144 /// <param name="fromAvatarName">The name of the user doing the sending</param> 145 /// <param name="fromAvatarName">
146 /// The name of the user doing the sending
147 /// </param>
145 /// <param name="message">The message being sent to the user</param> 148 /// <param name="message">The message being sent to the user</param>
146 void SendNotificationToUsersInRegion(UUID fromAvatarID, string fromAvatarName, string message); 149 void SendNotificationToUsersInRegion(UUID fromAvatarID,
150 string fromAvatarName, string message);
147 151
148 /// <summary> 152 /// <summary>
149 /// Send a textbox entry for the client to respond to 153 /// Send a textbox entry for the client to respond to
@@ -162,6 +166,7 @@ namespace OpenSim.Region.Framework.Interfaces
162 /// <param name="ownerid"> 166 /// <param name="ownerid">
163 /// UUID of the user that owns the object. 167 /// UUID of the user that owns the object.
164 /// </param> 168 /// </param>
165 void SendTextBoxToUser(UUID avatarid, string message, int chatChannel, string name, UUID objectid, UUID ownerid); 169 void SendTextBoxToUser(UUID avatarid, string message, int chatChannel,
170 string name, UUID objectid, UUID ownerid);
166 } 171 }
167} 172}