Skip to content

Commit 8c13979

Browse files
committed
Consistent input and output argument naming
Updated README accordingly.
1 parent 055ea1e commit 8c13979

File tree

2 files changed

+161
-156
lines changed

2 files changed

+161
-156
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ ans =
6464
-----------------
6565
<a name="addClasses"></a>
6666

67-
#### *mlapptools*.**addClasses**(*uiElement*, *cssClasses*)
67+
#### *mlapptools*.**addClasses**(*hUIElement*, *cssClasses*)
6868

6969
##### Description
7070

@@ -109,11 +109,11 @@ See example for [`addClasses`](#addClasses).
109109
-----------------
110110
<a name="fontColor"></a>
111111

112-
#### *mlapptools*.**fontColor**(*uiElement*, *color*)
112+
#### *mlapptools*.**fontColor**(*hUIElement*, *color*)
113113

114114
##### Description
115115

116-
Set the font color of the specified UI element, `'uiElement'`, to the input color, `color`. `color` can be a
116+
Set the font color of the specified UI element, `'hUIElement'`, to the input color, `color`. `color` can be a
117117
predefined color string or a string containing a valid CSS color method call.
118118

119119
Valid color specifications are:
@@ -143,11 +143,11 @@ mlapptools.fontColor(myGUI.TextArea, 'rgb(255,165,0)');
143143
-----------------
144144
<a name="fontWeight"></a>
145145

146-
#### *mlapptools*.**fontWeight**(*uiElement*, *weight*)
146+
#### *mlapptools*.**fontWeight**(*hUIElement*, *weight*)
147147

148148
##### Description
149149

150-
Set the font weight of the specified UI element, `uiElement`, to the input weight string or integer, `weight`.
150+
Set the font weight of the specified UI element, `hUIElement`, to the input weight string or integer, `weight`.
151151
For this setting to have an effect, the font being used must have built-in faces that match the specified weight.
152152

153153
Valid font weight property values are:
@@ -176,7 +176,7 @@ mlapptools.fontWeight(myGUI.TextArea, 600);
176176
-----------------
177177
<a name="getChildNodeIDs"></a>
178178

179-
#### *mlapptools*.**getChildNodeIDs**(*hWebWindow*,*widgetID*)
179+
#### *mlapptools*.**getChildNodeIDs**(*hWin*,*widgetID*)
180180

181181
##### Description
182182

@@ -185,13 +185,13 @@ A method for getting all children nodes (commonly `<div>` elements) of a specifi
185185
##### Examples
186186

187187
```MATLAB
188-
tg = uitabgroup(uifigure());
189-
uitab(tg);
190-
[win, widgetID] = mlapptools.getWebElements(tg);
191-
[childIDs] = mlapptools.getChildNodeIDs(win, widgetID);
192-
mlapptools.setStyle(win,'background','blue',childIDs(2));
193-
[childIDs] = mlapptools.getChildNodeIDs(win, childIDs(2));
194-
mlapptools.setStyle(win,'background','green',childIDs(4));
188+
hTG = uitabgroup(uifigure());
189+
uitab(hTG);
190+
[hWin, widgetID] = mlapptools.getWebElements(hTG);
191+
[childIDs] = mlapptools.getChildNodeIDs(hWin, widgetID);
192+
mlapptools.setStyle(hWin,'background','blue',childIDs(2));
193+
[childIDs] = mlapptools.getChildNodeIDs(hWin, childIDs(2));
194+
mlapptools.setStyle(hWin,'background','green',childIDs(4));
195195
```
196196

197197
-----------------
@@ -218,7 +218,7 @@ web(['text://' fullHTML]);
218218
-----------------
219219
<a name="getParentNodeID"></a>
220220

221-
#### *mlapptools*.**getParentNodeID**(*hWebWindow*,*widgetID*)
221+
#### *mlapptools*.**getParentNodeID**(*hWin*,*widgetID*)
222222

223223
##### Description
224224

@@ -230,15 +230,15 @@ Using the demo GUI generated by `./Demo/DOMdemoGUI.m`
230230

231231
```MATLAB
232232
tg = uitabgroup(uifigure());
233-
[win, widgetID] = mlapptools.getWebElements(tg);
234-
mlapptools.setStyle(win,'background','linear-gradient(red, pink, white)',...
235-
mlapptools.getParentNodeID(win, widgetID));
233+
[hWin, widgetID] = mlapptools.getWebElements(tg);
234+
mlapptools.setStyle(hWin,'background','linear-gradient(red, pink, white)',...
235+
mlapptools.getParentNodeID(hWin, widgetID));
236236
```
237237

238238
-----------------
239239
<a name="getWebElements"></a>
240240

241-
#### *mlapptools*.**getWebElements**(*uiElement*)
241+
#### *mlapptools*.**getWebElements**(*hUIElement*)
242242

243243
##### Description
244244

@@ -249,7 +249,7 @@ widget ID can be used to call the 4-parameter variant of [`setStyle`](#setStyle)
249249

250250
```MATLAB
251251
myGUI = DOMdemoGUI;
252-
[win, widgetID] = mlapptools.getWebElements(myGUI.TextArea);
252+
[hWin, widgetID] = mlapptools.getWebElements(myGUI.TextArea);
253253
```
254254

255255
-----------------
@@ -267,13 +267,13 @@ Using the demo GUI generated by `./Demo/DOMdemoGUI.m`
267267

268268
```MATLAB
269269
myGUI = DOMdemoGUI;
270-
win = mlapptools.getWebWindow(myGUI.UIFigure);
270+
hWin = mlapptools.getWebWindow(myGUI.UIFigure);
271271
```
272272

273273
-----------------
274274
<a name="getWidgetInfo"></a>
275275

276-
#### *mlapptools*.**getWidgetInfo**(*hWebwindow*, *widgetID*, *verbosityFlag*)
276+
#### *mlapptools*.**getWidgetInfo**(*hWin*, *widgetID*, *verbosityFlag*)
277277

278278
##### Description
279279

@@ -286,8 +286,8 @@ Using the demo GUI generated by `./Demo/DOMdemoGUI.m`
286286

287287
```MATLAB
288288
myGUI = DOMdemoGUI;
289-
[win, widgetID] = mlapptools.getWebElements(myGUI.TextArea);
290-
nfo = mlapptools.getWidgetInfo(win, widgetID);
289+
[hWin, widgetID] = mlapptools.getWebElements(myGUI.TextArea);
290+
nfo = mlapptools.getWidgetInfo(hWin, widgetID);
291291
```
292292

293293
-----------------
@@ -311,13 +311,13 @@ nfoList = mlapptools.getWidgetList(myGUI.UIFigure);
311311
-----------------
312312
<a name="setStyle"></a>
313313

314-
#### *mlapptools*.**setStyle**(*uiElement*, *styleAttr*, *styleValue*)
314+
#### *mlapptools*.**setStyle**(*hUIElement*, *styleAttr*, *styleValue*)
315315

316316
#### *mlapptools*.**setStyle**(*hWin*, *styleAttr*, *styleValue*, *ID_object*)
317317

318318
##### Description
319319

320-
Set the style attribute `styleAttr` of the specified UI element, `'uiElement'`, to the value `styleValue`. `styleAttr`
320+
Set the style attribute `styleAttr` of the specified UI element, `'hUIElement'`, to the value `styleValue`. `styleAttr`
321321
should be any valid CSS attribute, and `styleValue` a valid setting thereof.
322322

323323
This method provides a general interface to change CSS style attributes, with minimal input testing and error reporting,
@@ -355,10 +355,10 @@ mlapptools.setTimeout(myGUI.UIFigure, 3); % This will wait less for dojo queries
355355
-----------------
356356
<a name="textAlign"></a>
357357

358-
#### *mlapptools*.**textAlign**(*uiElement*, *alignment*)
358+
#### *mlapptools*.**textAlign**(*hUIElement*, *alignment*)
359359

360360
##### Description
361-
Set the horizontal text alignment of the specified UI element, `uiElement`, to that specified by the input alignment
361+
Set the horizontal text alignment of the specified UI element, `hUIElement`, to that specified by the input alignment
362362
string, `alignment`.
363363

364364
Valid alignment strings are:

0 commit comments

Comments
 (0)