/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSTimer.gsdoc is in gnustep-base-doc 1.25.1-2ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | <?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.4//EN" "http://www.gnustep.org/gsdoc-1_0_4.dtd">
<gsdoc base="NSTimer" up="Base">
<head>
<title>NSTimer class reference</title>
<author name="Andrew Kachites McCallum">
<email address="mccallum@gnu.ai.mit.edu">
mccallum@gnu.ai.mit.edu
</email>
</author>
<author name="Richard Frith-Macdonald">
<email address="rfm@gnu.org">
rfm@gnu.org
</email>
</author>
<copy>1995, 1996, 1999 Free Software Foundation, Inc.</copy>
</head>
<body>
<front><contents /></front>
<chapter>
<heading>
Software documentation for the NSTimer class
</heading>
<class name="NSTimer" super="NSObject" ovadd="1.0.0">
<declared>Foundation/NSTimer.h</declared>
<desc>
<p>
An <code>NSTimer</code> provides a way to send a message
at some time in the future, possibly repeating every
time a fixed interval has passed. To use a timer, you
can either create one that will automatically be added
to the run loop in the current thread (using the
<ref type="method" id="-addTimer:forMode:">
-addTimer:forMode:
</ref>
method), or you can create it without adding it
then add it to an
<ref type="class" id="NSRunLoop">NSRunLoop</ref>
explicitly later.
</p>
<p>
NB. You may not use
<ref type="method" id="-init">
-init
</ref>
or <ref type="method" id="+new">+new</ref> to create a
timer, as the timer must be properly initialised
to send an action after some interval.
</p>
</desc>
<ivariable type="NSDate*" name="_date" validity="public" ovadd="1.0.0">
<desc>
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</desc>
</ivariable>
<ivariable type="id" name="_info" validity="public" ovadd="1.0.0">
<desc>
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</desc>
</ivariable>
<ivariable type="NSTimeInterval" name="_interval" validity="public" ovadd="1.0.0">
<desc>
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</desc>
</ivariable>
<ivariable type="BOOL" name="_invalidated" validity="public" ovadd="1.0.0">
<desc>
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</desc>
</ivariable>
<ivariable type="BOOL" name="_repeats" validity="public" ovadd="1.0.0">
<desc>
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</desc>
</ivariable>
<ivariable type="SEL" name="_selector" validity="public" ovadd="1.0.0">
<desc>
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</desc>
</ivariable>
<ivariable type="id" name="_target" validity="public" ovadd="1.0.0">
<desc>
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</desc>
</ivariable>
<method type="NSTimer*" factory="yes" ovadd="1.0.0">
<sel>scheduledTimerWithTimeInterval:</sel>
<arg type="NSTimeInterval">ti</arg>
<sel>invocation:</sel>
<arg type="NSInvocation*">invocation</arg>
<sel>repeats:</sel>
<arg type="BOOL">f</arg>
<desc>
Create a timer which will fire after <var>ti</var>
seconds and, if <var>f</var> is <code>YES</code>,
every <var>ti</var> seconds thereafter. On firing,
<var>invocation</var> will be performed. <br /> This
timer will automatically be added to the current run
loop and will fire in the default run loop mode.
</desc>
</method>
<method type="NSTimer*" factory="yes" ovadd="1.0.0">
<sel>scheduledTimerWithTimeInterval:</sel>
<arg type="NSTimeInterval">ti</arg>
<sel>target:</sel>
<arg type="id">object</arg>
<sel>selector:</sel>
<arg type="SEL">selector</arg>
<sel>userInfo:</sel>
<arg type="id">info</arg>
<sel>repeats:</sel>
<arg type="BOOL">f</arg>
<desc>
Create a timer which will fire after <var>ti</var>
seconds and, if <var>f</var> is <code>YES</code>,
every <var>ti</var> seconds thereafter. On firing,
the target <var>object</var> will be sent a message
specified by <var>selector</var> and with the
timer as its argument. <br /> This timer will
automatically be added to the current run
loop and will fire in the default run loop mode.
</desc>
</method>
<method type="NSTimer*" factory="yes" ovadd="1.0.0">
<sel>timerWithTimeInterval:</sel>
<arg type="NSTimeInterval">ti</arg>
<sel>invocation:</sel>
<arg type="NSInvocation*">invocation</arg>
<sel>repeats:</sel>
<arg type="BOOL">f</arg>
<desc>
Create a timer which will fire after <var>ti</var>
seconds and, if <var>f</var> is <code>YES</code>,
every <var>ti</var> seconds thereafter. On firing,
<var>invocation</var> will be performed. <br /> NB.
To make the timer operate, you must add it to a run
loop.
</desc>
</method>
<method type="NSTimer*" factory="yes" ovadd="1.0.0">
<sel>timerWithTimeInterval:</sel>
<arg type="NSTimeInterval">ti</arg>
<sel>target:</sel>
<arg type="id">object</arg>
<sel>selector:</sel>
<arg type="SEL">selector</arg>
<sel>userInfo:</sel>
<arg type="id">info</arg>
<sel>repeats:</sel>
<arg type="BOOL">f</arg>
<desc>
Create a timer which will fire after <var>ti</var>
seconds and, if <var>f</var> is <code>YES</code>,
every <var>ti</var> seconds thereafter. On firing,
the target <var>object</var> will be sent a message
specified by <var>selector</var> and with the
timer as its argument. <br /> NB. To make the timer
operate, you must add it to a run loop.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>fire</sel>
<desc>
Fires the timer... either performs an invocation or
sends a message to a target object, depending on how
the timer was set up. <br /> If the timer is not set to
repeat, it is automatically invalidated. <br />
Exceptions raised during firing of the timer are
caught and logged.
</desc>
</method>
<method type="NSDate*" ovadd="1.0.0">
<sel>fireDate</sel>
<desc>
Returns the date/time at which the timer is next
due to fire.
</desc>
</method>
<method type="id" init="yes" ovadd="10.2.0">
<sel>initWithFireDate:</sel>
<arg type="NSDate*">fd</arg>
<sel>interval:</sel>
<arg type="NSTimeInterval">ti</arg>
<sel>target:</sel>
<arg type="id">object</arg>
<sel>selector:</sel>
<arg type="SEL">selector</arg>
<sel>userInfo:</sel>
<arg type="id">info</arg>
<sel>repeats:</sel>
<arg type="BOOL">f</arg>
<desc>
Initialise the receive, a newly allocated
NSTimer <var>object</var>. <br /> The <var>ti</var>
argument specifies the time (in seconds) between
the firing. If it is less than or equal to 0.0 then a
small interval is chosen automatically. <br /> The
<var>fd</var> argument specifies an initial fire date
copied by the timer... if it is not supplied (a
<code>nil</code> <var>object</var>) then the
<var>ti</var> argument is used to create a start date
relative to the current time. <br /> The
<var>f</var> argument specifies whether the timer
will fire repeatedly or just once. <br /> If the
<var>selector</var> argument is zero, then then
<var>object</var> is an invocation to be used when
the timer fires. otherwise, the <var>object</var> is
sent the message specified by the <var>selector</var>
and with the timer as an argument. <br /> The
<var>object</var> and <var>info</var> arguments will
be retained until the timer is invalidated.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>invalidate</sel>
<desc>
Marks the timer as invalid, causing its
target/invocation and user info objects
to be released. <br /> Invalidated timers are
automatically removed from the run loop when
it detects them.
</desc>
</method>
<method type="BOOL" ovadd="10.0.0">
<sel>isValid</sel>
<desc>
Checks to see if the timer has been invalidated.
</desc>
</method>
<method type="void" ovadd="10.2.0">
<sel>setFireDate:</sel>
<arg type="NSDate*">fireDate</arg>
<desc>
Change the fire date for the receiver. <br /> NB.
You should <em>NOT</em> use this method for a timer
which has been added to a run loop. The only time
when it is safe to modify the fire date of a timer in
a run loop is for a repeating timer when the timer is
actually in the process of firing.
</desc>
</method>
<method type="NSTimeInterval" ovadd="10.0.0">
<sel>timeInterval</sel>
<desc>
Returns the interval between firings, or zero if
the timer does not repeat.
</desc>
</method>
<method type="id" ovadd="1.0.0">
<sel>userInfo</sel>
<desc>
Returns the user info which was set for the timer
when it was created, or <code>nil</code> if none was
set or the timer is invalid.
</desc>
</method>
</class>
</chapter>
</body>
</gsdoc>
|