source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/str_size.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 5.7 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>str_size.pro (IDLdoc API documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="str_size.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="putfile.html">&lt;&lt;prev file</a> | <a href="strcnt.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="str_size.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/STRING/</a></h1>
82      <h2 class="pro_file">str_size.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_STR_SIZE">
103
104          <h2><a class="top" href="#container">top</a>STR_SIZE </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>STR_SIZE(<span class="result"><a href="#_STR_SIZE_param_string">string</a>, <a href="#_STR_SIZE_param_targetWidth">targetWidth</a></span>, <a href="#_STR_SIZE_keyword_INITSIZE">INITSIZE</a>=<span class="result">INITSIZE</span>, <a href="#_STR_SIZE_keyword_STEP">STEP</a>=<span class="result">STEP</span>)</p>
108       
109          <div class="comments">
110 NAME:
111  STR_SIZE
112
113 PURPOSE:
114
115  The purpose of this function is to return the proper
116  character size to make a specified string a specifed
117  width in a window. The width is specified in normalized
118  coordinates. The function is extremely useful for sizing
119  strings and labels in resizeable graphics windows.
120
121 CATEGORY:
122
123  Graphics Programs, Widgets.
124
125 CALLING SEQUENCE:
126
127  thisCharSize = STR_SIZE(thisSting, targetWidth)
128
129 INPUTS:
130
131  thisString:  This is the string that you want to make a specifed
132     target size or width.
133
134 OPTIONAL INPUTS:
135
136  targetWidth:  This is the target width of the string in normalized
137     coordinates in the current graphics window. The character
138     size of the string (returned as thisCharSize) will be
139     calculated to get the string width as close as possible to
140     the target width. The default is 0.25.
141
142 KEYWORD PARAMETERS:
143
144  INITSIZE:  This is the initial size of the string. Default is 1.0.
145
146  STEP:   This is the amount the string size will change in each step
147     of the interative process of calculating the string size.
148     The default value is 0.05.
149
150 OUTPUTS:
151
152  thisCharSize:  This is the size the specified string should be set
153     to if you want to produce output of the specified target
154     width. The value is in standard character size units where
155     1.0 is the standard character size.
156
157 EXAMPLE:
158
159  To make the string "Happy Holidays" take up 30% of the width of
160  the current graphics window, type this:
161
162               XYOUTS, 0.5, 0.5, ALIGN=0.5, "Happy Holidays", $
163        CHARSIZE=STR_SIZE("Happy Holidays", 0.3)
164
165 MODIFICATION HISTORY:
166
167  Written by: David Fanning, 17 DEC 96.
168  Added a scaling factor to take into account the aspect ratio
169     of the window in determing the character size. 28 Oct 97. DWF</div>
170
171         
172
173         
174            <h3>Parameters</h3>
175       
176           
177            <h4 id="_STR_SIZE_param_string">string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178             
179             
180             
181             
182             
183             
184             
185             
186            </h4>
187       
188          <div class="comments"></div>
189           
190            <h4 id="_STR_SIZE_param_targetWidth">targetWidth&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
191             
192             
193             
194             
195             
196             
197             
198             
199            </h4>
200       
201          <div class="comments"></div>
202           
203
204         
205
206         
207
208            <h3>Keywords</h3>
209           
210            <h4 id="_STR_SIZE_keyword_INITSIZE">INITSIZE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
211             
212             
213             
214             
215             
216             
217             
218             
219            </h4>
220       
221            <div class="comments"></div>
222           
223            <h4 id="_STR_SIZE_keyword_STEP">STEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
224             
225             
226             
227             
228             
229             
230             
231             
232            </h4>
233       
234            <div class="comments"></div>
235           
236         
237
238         
239         
240         
241         
242         
243         
244         
245         
246         
247         
248         
249         
250       
251         
252         
253         
254         
255         
256         
257         
258       
259         
260       
261        </div>
262       
263      </div>
264
265     
266
267      <div id="tagline">Produced by IDLdoc 2.0.</div>
268
269    </div>
270
271  </body>
272</html>
Note: See TracBrowser for help on using the repository browser.