VirtualBox

Changeset 14083 in vbox


Ignore:
Timestamp:
Nov 11, 2008 10:45:21 AM (16 years ago)
Author:
vboxsync
Message:

Corrected typos spotted by ispell. I've checked twice I didn't change any
identifiers in double quotes, so the interface definition should be
unaffected. There's more to do, however, as the grammar may need some
brushing here and there, too.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Main/idl/VirtualBox.xidl

    r14020 r14083  
    7676  <!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
    7777  <cpp>
    78 /* currenty, nsISupportsImpl.h lacks the below-like macros */
     78/* currently, nsISupportsImpl.h lacks the below-like macros */
    7979
    8080#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI  NS_IMPL_QUERY_INTERFACE1_CI
    … …  
    213213          For whoever decides to touch this enum: In order to keep the
    214214          aforementioned comparisons valid, this state must immediately
    215           preceed the Paused state.
     215          precede the Paused state.
    216216        </note>
    217217      </desc>
    … …  
    531531    <const name="MemKernelNonpaged"    value="13">
    532532      <desc>
    533         Total amount of nonpaged memory used by the guest OS's kernel in megabytes.
     533        Total amount of non-paged memory used by the guest OS's kernel in megabytes.
    534534      </desc>
    535535    </const>
    … …  
    13681368        Note that the actual storage unit is not created by this method. In
    13691369        order to do it, and before you are able to attach the created hard disk
    1370         to virtual machiens, you must call one of the following methods to
     1370        to virtual machines, you must call one of the following methods to
    13711371        allocate a format-specific storage unit at the specified location:
    13721372        <ul>
    … …  
    13821382        After the storage unit is successfully created, the hard disk gets
    13831383        remembered by this VirtualBox installation and will be accessible
    1384         trhough <link to="#getHardDisk2()"/> and <link to="#findHardDisk2()"/>
     1384        through <link to="#getHardDisk2()"/> and <link to="#findHardDisk2()"/>
    13851385        methods. Remembered root (base) hard disks are also returned as part of
    13861386        the <link to="#hardDisks2"/> array. See IHardDisk2 for more details.
    … …  
    14151415        After the hard disk is successfully opened by this method, it gets
    14161416        remembered by (known to) this VirtualBox installation and will be
    1417         accessible trhough <link to="#getHardDisk2()"/> and
     1417        accessible through <link to="#getHardDisk2()"/> and
    14181418        <link to="#findHardDisk2()"/> methods. Remembered root (base) hard disks
    14191419        are also returned as part of the <link to="#hardDisks2"/> array and can
    … …  
    14741474        disk.
    14751475
    1476         For locations repesented by file names in the host's filesystem, the
     1476        For locations represented by file names in the host's file system, the
    14771477        requested location can be a path relative to the
    14781478        <link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
    14791479        only a file name without any path is given, the
    14801480        <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
    1481         folder</link> will be prepended to the file name before seacrhing. Note
    1482         that on case sensitive filesystems, a case sensitive comparison is
     1481        folder</link> will be prepended to the file name before searching. Note
     1482        that on case sensitive file systems, a case sensitive comparison is
    14831483        performed, otherwise the case of symbols in the file path is ignored.
    14841484      </desc>
    … …  
    14981498        After the image is successfully opened by this method, it gets
    14991499        remembered by (known to) this VirtualBox installation and will be
    1500         accessible trhough <link to="#getDVDImage()"/> and
     1500        accessible through <link to="#getDVDImage()"/> and
    15011501        <link to="#findDVDImage()"/> methods. Remembered images are also
    15021502        returned as part of the <link to="#DVDImages"/> array and can be mounted
    … …  
    15581558        only a file name without any path is given, the
    15591559        <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
    1560         folder</link> will be prepended to the file name before seacrhing. Note
    1561         that on case sensitive filesystems, a case sensitive comparison is
     1560        folder</link> will be prepended to the file name before searching. Note
     1561        that on case sensitive file systems, a case sensitive comparison is
    15621562        performed, otherwise the case of symbols in the file path is ignored.
    15631563      </desc>
    … …  
    15771577        After the image is successfully opened by this method, it gets
    15781578        remembered by (known to) this VirtualBox installation and will be
    1579         accessible trhough <link to="#getFloppyImage()"/> and
     1579        accessible through <link to="#getFloppyImage()"/> and
    15801580        <link to="#findFloppyImage()"/> methods. Remembered images are also
    15811581        returned as part of the <link to="#floppyImages"/> array and can be
    … …  
    15911591      <param name="location" type="wstring" dir="in">
    15921592        <desc>
    1593           Full path to the file that contains a valid floopy image.
     1593          Full path to the file that contains a valid floppy image.
    15941594        </desc>
    15951595      </param>
    … …  
    16371637        only a file name without any path is given, the
    16381638        <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
    1639         folder</link> will be prepended to the file name before seacrhing. Note
    1640         that on case sensitive filesystems, a case sensitive comparison is
     1639        folder</link> will be prepended to the file name before searching. Note
     1640        that on case sensitive file systems, a case sensitive comparison is
    16411641        performed, otherwise the case of symbols in the file path is ignored.
    16421642      </desc>
    … …  
    22412241        <desc>
    22422242          Used to wait until the corresponding machine is actually
    2243           deassociated from the given session on the server.
     2243          dissociated from the given session on the server.
    22442244          Returned only when this session is a direct one.
    22452245        </desc>
    … …  
    23822382      <desc>
    23832383        Get the list of the guest properties matching a set of patterns along
    2384         with their values, timestamps and flags and give responsibility for
     2384        with their values, time stamps and flags and give responsibility for
    23852385        managing properties to the console.
    23862386      </desc>
    … …  
    23982398      <param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
    23992399        <desc>
    2400           The timestamps of the properties returned.  The array entries match
     2400          The time stamps of the properties returned.  The array entries match
    24012401          the corresponding entries in the @a name array.
    24022402        </desc>
    … …  
    24132413      <desc>
    24142414        Set the list of the guest properties matching a set of patterns along
    2415         with their values, timestamps and flags and return responsibility for
     2415        with their values, time stamps and flags and return responsibility for
    24162416        managing properties to IMachine.
    24172417      </desc>
    … …  
    24292429      <param name="timestamp" type="unsigned long long" dir="in" safearray="yes">
    24302430        <desc>
    2431           The timestamps of the properties.  The array entries match
     2431          The time stamps of the properties.  The array entries match
    24322432          the corresponding entries in the @a name array.
    24332433        </desc>
    … …  
    25782578
    25792579    <attribute name="parent" type="IVirtualBox" readonly="yes">
    2580       <desc>Associated parent obect.</desc>
     2580      <desc>Associated parent object.</desc>
    25812581    </attribute>
    25822582
    … …  
    29912991        recorded during machine execution. The most recent log file is
    29922992        named <tt>VBox.log</tt>, the previous log file is
    2993         named <tt>VBox.log.1</tt> and so on (upto <tt>VBox.log.3</tt>
     2993        named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
    29942994        in the current version).
    29952995      </desc>
    … …  
    31413141        For the primary controller of the IDE bus, the @a device number can be
    31423142        either @c 0 or @c 1, to specify the master or the slave device,
    3143         respectively. For the scondary IDE controller, the device number is
     3143        respectively. For the secondary IDE controller, the device number is
    31443144        always @c 1 because the master device is reserved for the CD-ROM drive.
    31453145
    … …  
    31613161          If the hard disk is being attached indirectly, a new differencing hard
    31623162          disk will be implicitly created for it and attached instead. If the
    3163           changes made to the machine settings (icluding this indirect
     3163          changes made to the machine settings (including this indirect
    31643164          attachment) are later cancelled using <link to="#discardSettings()"/>,
    3165           this implicitly created diffrerencing hard disk will be implicitly
     3165          this implicitly created differencing hard disk will be implicitly
    31663166          deleted.
    31673167        </note>
    … …  
    32143214
    32153215        Detaching the hard disk from the virtual machine is deferred. This means
    3216         that the hard disk remains associated with the machine when this methor
     3216        that the hard disk remains associated with the machine when this method
    32173217        returns and gets actually de-associated only after a successful
    32183218        <link to="#saveSettings()"/> call. See <link to="IHardDisk2"/>
    … …  
    36883688      <desc>
    36893689        Return a list of the guest properties matching a set of patterns along
    3690         with their values, timestamps and flags.
     3690        with their values, time stamps and flags.
    36913691      </desc>
    36923692      <param name="patterns" type="wstring" dir="in">
    … …  
    37093709      <param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
    37103710        <desc>
    3711           The timestamps of the properties returned.  The array entries match
     3711          The time stamps of the properties returned.  The array entries match
    37123712          the corresponding entries in the @a name array.
    37133713        </desc>
    … …  
    39563956      </desc>
    39573957      <param name="scope" type="Scope" dir="in">
    3958         <desc>Sope of the notification.</desc>
     3958        <desc>Scope of the notification.</desc>
    39593959      </param>
    39603960    </method>
    … …  
    40034003        to the user and take the corresponding action.
    40044004
    4005         Currently, the following error identificators are known:
     4005        Currently, the following error identifiers are known:
    40064006        <ul>
    40074007          <li><tt>"HostMemoryLow"</tt></li>
    … …  
    40244024      </param>
    40254025      <param name="id" type="wstring" dir="in">
    4026         <desc>Error identificator</desc>
     4026        <desc>Error identifier</desc>
    40274027      </param>
    40284028      <param name="message" type="wstring" dir="in">
    … …  
    45524552        of the virtual machine.
    45534553
    4554         After this method succeeds, the VirtualBox server reinitiates
     4554        After this method succeeds, the VirtualBox server re-initiates
    45554555        all USB filters as if the device were just physically attached
    45564556        to the host, but filters of this machine are ignored to avoid
    4557         a possible automatic reattachment.
     4557        a possible automatic re-attachment.
    45584558
    45594559        <see>IUSBController::deviceFilters, USBDeviceState</see>
    … …  
    52825282
    52835283    <attribute name="minGuestRAM" type="unsigned long" readonly="yes">
    5284       <desc>Minium guest system memory in Megabytes.</desc>
     5284      <desc>Minimum guest system memory in Megabytes.</desc>
    52855285    </attribute>
    52865286
    … …  
    53715371
    53725372        This path is used when the storage unit of a hard disk is a regular file
    5373         in the host's filesystem and only a file name that contains no path is
     5373        in the host's file system and only a file name that contains no path is
    53745374        given.
    53755375
    … …  
    54605460        library that is used by default for VBoxVRDP (again, see
    54615461        <link to="ISystemProperties::remoteDisplayAuthLibrary" />).
    5462         The format and calling convetion of authentication libraries
     5462        The format and calling convention of authentication libraries
    54635463        is the same for the webservice as it is for VBoxVRDP.
    54645464
    … …  
    56165616      </param>
    56175617      <param name="domain" type="wstring" dir="in">
    5618         <desc>Domain name (guest logon scheme specific), can be emtpy</desc>
     5618        <desc>Domain name (guest logon scheme specific), can be empty</desc>
    56195619      </param>
    56205620      <param name="allowInteractiveLogon" type="boolean" dir="in">
    … …  
    58545854      snapshot to the top of that branch.
    58555855
    5856       Existings snapshots can be discarded using
     5856      Existing snapshots can be discarded using
    58575857      <link to="IConsole::discardSnapshot()"/>.
    58585858
    … …  
    61126112      automatically remembered by the given VirtualBox installation or, in other
    61136113      words, becomes a <i>known medium</i>. Known media are stored in the media
    6114       registry transparently maintaned by VirtualBox and stored in settings
     6114      registry transparently maintained by VirtualBox and stored in settings
    61156115      files so that this registry is preserved when VirtualBox is not running.
    61166116
    … …  
    61396139      value of the <link to="#state"/> attribute. When the storage unit cannot
    61406140      be read (for example, because it is located on a disconnected network
    6141       resource, or was accidentially deleted outside VirtualBox), the medium is
     6141      resource, or was accidentally deleted outside VirtualBox), the medium is
    61426142      considered to be <i>inaccessible</i> which is indicated by the
    61436143      <link to="MediaState::Inaccessible"/> state. The details about the reason
    … …  
    61456145      <link to="#lastAccessError"/> attribute.
    61466146
    6147       A new accessiblity check is performed each time the <link to="#state"/>
     6147      A new accessibility check is performed each time the <link to="#state"/>
    61486148      attribute is read. Please note that this check may take long time (several
    61496149      seconds or even minutes, depending on the storage unit location and
    … …  
    62026202
    62036203        If the last known state of the medium is <link to="MediaState::Created"/>
    6204         and the accessibility check fails then the state wull be set to
     6204        and the accessibility check fails then the state would be set to
    62056205        <link to="MediaState::Inaccessible"/> and <link to="#lastAccessError"/>
    62066206        may be used to get more details about the failure. If the state of the
    … …  
    62226222        Location of the storage unit holding media data.
    62236223
    6224         The format of the loocation string is media type specific. For media
     6224        The format of the location string is media type specific. For media
    62256225        types that use regular files in a host's file system, the location
    62266226        string is just a full file name.
    … …  
    62756275    <attribute name="lastAccessError" type="wstring" readonly="yes">
    62766276      <desc>
    6277         Text message that represents the result of the last acccessibility
     6277        Text message that represents the result of the last accessibility
    62786278        check.
    62796279
    62806280        Accessibility checks are performed each time the <link to="#state"/>
    62816281        attribute is read. A @c null string is returned if the last
    6282         accessibility check was succeessful. A non-null string indicates a
     6282        accessibility check was successful. A non-null string indicates a
    62836283        failure and should normally describe a reason of the failure (for
    62846284        example, a file read error).
    … …  
    63106310        first element in the array will always be the ID of the queried machine
    63116311        (i.e. the value equal to the @c machineId argument), followed by
    6312         snapshit IDs (if any).
     6312        snapshot IDs (if any).
    63136313
    63146314        If the medium is not attached to the machine in the current state, then
    … …  
    63556355
    63566356        This method sets the media state to <link to="MediaState::LockedRead"/>
    6357         on success. The state proir to this call must be
     6357        on success. The state prior to this call must be
    63586358        <link to="MediaState::Created"/>,
    63596359        <link to="MediaState::Inaccessible"/> or
    6360         <link to="MediaState::LockedRead"/>. As you can see, inacessible media
     6360        <link to="MediaState::LockedRead"/>. As you can see, inaccessible media
    63616361        can be locked too. This is not an error; this method performs a logical
    63626362        lock that prevents modifications of this media through the VirtualBox
    … …  
    64146414
    64156415        This method sets the media state to <link to="MediaState::LockedWrite"/>
    6416         on success. The state proir to this call must be
     6416        on success. The state prior to this call must be
    64176417        <link to="MediaState::Created"/> or
    6418         <link to="MediaState::Inaccessible"/>. As you can see, inacessible media
     6418        <link to="MediaState::Inaccessible"/>. As you can see, inaccessible media
    64196419        can be locked too. This is not an error; this method performs a logical
    64206420        lock that prevents modifications of this media through the VirtualBox
    … …  
    64516451        Closes this media.
    64526452
    6453         The hard disk must not be attahced to any known virtual machine and must
     6453        The hard disk must not be attached to any known virtual machine and must
    64546454        not have any known child hard disks, otherwise the operation will fail.
    64556455
    … …  
    66156615
    66166616      If the storage unit of the hard disk is a regular file in the host's
    6617       filesystem then the rules stated in the description of the
     6617      file system then the rules stated in the description of the
    66186618      <link to="IMedium::location"/> attribute apply when setting its value. In
    66196619      addition, a plain file name without any path may be given, in which case
    … …  
    66316631      specification which only contains the path specification but not the file
    66326632      name part and ends with either a forward slash or a backslash character.
    6633       In response, VirtualBox will genereate a new UUID for the hard disk and
     6633      In response, VirtualBox will generate a new UUID for the hard disk and
    66346634      compose the file name using the following pattern:
    66356635      <pre>
    … …  
    66396639      <tt>&lt;uuid&gt;</tt> is the newly generated UUID and <tt>&lt;ext&gt;</tt>
    66406640      is the default extension for the storage format of this hard disk. After
    6641       that, you may call any of the metods that create a new hard disk storage
     6641      that, you may call any of the methods that create a new hard disk storage
    66426642      unit and they will use the generated UUID and file name.
    66436643
    … …  
    66986698          <td>Immutable</td>
    66996699          <td>
    6700             Immutabe hard disks are always attached <b>indirectly</b> because
     6700            Immutable hard disks are always attached <b>indirectly</b> because
    67016701            they are designed to be non-writable. If an immutable hard disk is
    67026702            attached to a virtual machine with snapshots then a special
    … …  
    67526752
    67536753      When normal base or immutable hard disks are indirectly attached to a
    6754       virtual machine then some additionals steps are performed to make sure the
     6754      virtual machine then some additional steps are performed to make sure the
    67556755      virtual machine will have the most recent "view" of the hard disk being
    67566756      attached. These steps include walking through the machine's snapshots
    … …  
    68096809      as described above, the backup copy of the current list of hard disk
    68106810      attachment is searched for descendants. This backup copy is created when
    6811       the hard disk configuartion is changed for the first time after the last
     6811      the hard disk configuration is changed for the first time after the last
    68126812      <link to="IMachine::saveSettings()"/> call and used by
    68136813      <link to="IMachine::discardSettings()"/> to undo the recent hard disk
    68146814      changes. When such a descendant is found in this backup copy, it will be
    6815       simply reattached back, without creating a new differencing hard disk for
     6815      simply re-attached back, without creating a new differencing hard disk for
    68166816      it. This optimization is necessary to make it possible to re-attach the
    68176817      base or immutable hard disk to a different bus, channel or device slot
    … …  
    68946894
    68956895        A hard disk is considered to be read-only when its contents cannot be
    6896         modified without breaking the integrity of other parties that depednd on
     6896        modified without breaking the integrity of other parties that depend on
    68976897        this hard disk such as its child hard disks or snapshots of virtual
    68986898        machines where this hard disk is attached to these machines. If there
    … …  
    69246924      <desc>
    69256925        Logical size of this hard disk (in megabytes), as reported to the
    6926         guest OS running inside the vurtual machine this disk is
     6926        guest OS running inside the virtual machine this disk is
    69276927        attached to. The logical size is defined when the hard disk is created
    69286928        and cannot be changed later.
    … …  
    69456945    <method name="createDynamicStorage">
    69466946      <desc>
    6947         Starts creating a dymically expanding hard disk storage unit in the
     6947        Starts creating a dynamically expanding hard disk storage unit in the
    69486948        background. The previous storage unit created for this this object, if
    69496949        any, must be first deleted using <link to="#deleteStorage"/>, otherwise
    … …  
    69976997        Starts deleting the storage unit of this hard disk.
    69986998
    6999         The hard disk must not be attahced to any known virtual machine and must
     6999        The hard disk must not be attached to any known virtual machine and must
    70007000        not have any known child hard disks, otherwise the operation will fail.
    70017001        It will also fail if there is no storage unit to delete or if deletion
    … …  
    70907090        disk itself since it will no longer be based on any other hard disk.
    70917091
    7092         Considering the above, all of the following condtions must be met in
     7092        Considering the above, all of the following conditions must be met in
    70937093        order for the merge operation to succeed:
    70947094        <ul>
    … …  
    72787278        The format backend operates on files. The <link to="IMedium::location"/>
    72797279        attribute of the hard disk specifies a file used to store hard disk
    7280         data. For a list of supported file extentions see
     7280        data. For a list of supported file extensions see
    72817281        <link to="IHardDiskFormat::fileExtensions"/>.
    72827282      </desc>
    … …  
    72877287        The format backend uses the property interface to configure the storage
    72887288        location and properties. The <link to="IHardDiskFormat::describeProperties"/>
    7289         method is used to get access to poperties supported by the given hard
     7289        method is used to get access to properties supported by the given hard
    72907290        disk format.
    72917291      </desc>
    … …  
    73417341
    73427342        The first extension in the array is the extension preferred by the
    7343         backend. It is recommended to use this extension when specifyng a
     7343        backend. It is recommended to use this extension when specifying a
    73447344        location of the storage unit for a new hard disk.
    73457345
    … …  
    73557355        Capabilities of the format as a set of bit flags.
    73567356
    7357         For the meaning of individual capabilitiy flags see
     7357        For the meaning of individual capability flags see
    73587358        <link to="HardDiskFormatCapabilities"/>.
    73597359      </desc>
    … …  
    76347634      <param name="dx" type="long" dir="in">
    76357635        <desc>
    7636           Amout of pixels the mouse should move to the right.
     7636          Amount of pixels the mouse should move to the right.
    76377637          Negative values move the mouse to the left.
    76387638        </desc>
    … …  
    76407640      <param name="dy" type="long" dir="in">
    76417641        <desc>
    7642           Amout of pixels the mouse should move downwards.
     7642          Amount of pixels the mouse should move downwards.
    76437643          Negative values move the mouse upwards.
    76447644        </desc>
    … …  
    76937693      <param name="dz" type="long" dir="in">
    76947694        <desc>
    7695           Amout of mouse wheel moves.
     7695          Amount of mouse wheel moves.
    76967696          Positive values describe clockwise wheel rotations,
    76977697          negative values describe counterclockwise rotations.
    … …  
    77257725  >
    77267726    <desc>
    7727       Framebuffer acceleration operation.
     7727      Frame buffer acceleration operation.
    77287728    </desc>
    77297729
    … …  
    77657765     >
    77667766    <attribute name="address" type="octet" mod="ptr" readonly="yes">
    7767       <desc>Address of the start byte of the framebuffer.</desc>
     7767      <desc>Address of the start byte of the frame buffer.</desc>
    77687768    </attribute>
    77697769
    77707770    <attribute name="width" type="unsigned long" readonly="yes">
    7771       <desc>Framebuffer width, in pixels.</desc>
     7771      <desc>Frame buffer width, in pixels.</desc>
    77727772    </attribute>
    77737773
    77747774    <attribute name="height" type="unsigned long" readonly="yes">
    7775       <desc>Framebuffer height, in pixels.</desc>
     7775      <desc>Frame buffer height, in pixels.</desc>
    77767776    </attribute>
    77777777
    … …  
    77947794    <attribute name="pixelFormat" type="unsigned long" readonly="yes">
    77957795      <desc>
    7796         Framebuffer pixel format. It's either one of the values defined by <link
     7796        Frame buffer pixel format. It's either one of the values defined by <link
    77977797        to="FramebufferPixelFormat"/> or a raw FOURCC code.
    77987798        <note>
    … …  
    78067806    <attribute name="usesGuestVRAM" type="boolean" readonly="yes">
    78077807      <desc>
    7808         Defines whether this framebuffer uses the virtual video card's memory
     7808        Defines whether this frame buffer uses the virtual video card's memory
    78097809        buffer (guest VRAM) directly or not. See <link
    78107810        to="IFramebuffer::requestResize()"/> for more information.
    … …  
    78147814    <attribute name="heightReduction" type="unsigned long" readonly="yes">
    78157815      <desc>
    7816         Hint from the framebuffer about how much of the standard
     7816        Hint from the frame buffer about how much of the standard
    78177817        screen height it wants to use for itself. This information is
    78187818        exposed to the guest through the VESA BIOS and VMMDev interface
    … …  
    78247824    <attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
    78257825      <desc>
    7826         An alpha-blended overlay which is superposed over the framebuffer.
     7826        An alpha-blended overlay which is superposed over the frame buffer.
    78277827        The initial purpose is to allow the display of icons providing
    78287828        information about the VM state, including disk activity, in front
    … …  
    78407840      <desc>
    78417841        Platform-dependent identifier of the window where context of this
    7842         framebuffer is drawn, or zero if there's no such window.
     7842        frame buffer is drawn, or zero if there's no such window.
    78437843      </desc>
    78447844    </attribute>
    … …  
    78467846    <method name="lock">
    78477847      <desc>
    7848         Locks the framebuffer.
    7849         Gets called by the IDisplay object where this framebuffer is
     7848        Locks the frame buffer.
     7849        Gets called by the IDisplay object where this frame buffer is
    78507850        bound to.
    78517851      </desc>
    … …  
    78547854    <method name="unlock">
    78557855      <desc>
    7856         Unlocks the framebuffer.
    7857         Gets called by the IDisplay object where this framebuffer is
     7856        Unlocks the frame buffer.
     7857        Gets called by the IDisplay object where this frame buffer is
    78587858        bound to.
    78597859      </desc>
    … …  
    79127912        bitsPerPixel and @a bytesPerLine define the format of the video memory
    79137913        buffer pointed to by the @a VRAM parameter and the implementation is
    7914         free to choose which mode to use. To indicate that this framebuffer uses
     7914        free to choose which mode to use. To indicate that this frame buffer uses
    79157915        the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
    79167916        attribute must return <tt>true</tt> and <link to="#address"/> must
    … …  
    79247924        display mode. In case of direct mode, it is guaranteed that the given @a
    79257925        VRAM buffer contains enough space to represent the display mode of the
    7926         given size. Note that this framebuffer's <link to="#width"/> and <link
     7926        given size. Note that this frame buffer's <link to="#width"/> and <link
    79277927        to="#height"/> attributes must return exactly the same values as
    79287928        passed to this method after the resize is completed (see below).
    79297929
    79307930        The @a finished output parameter determines if the implementation has
    7931         finished resizing the framebuffer or not. If, for some reason, the
     7931        finished resizing the frame buffer or not. If, for some reason, the
    79327932        resize cannot be finished immediately during this call, @a finished
    79337933        must be set to @c false, and the implementation must call
    79347934        <link to="IDisplay::resizeCompleted()"/> after it has returned from
    79357935        this method as soon as possible. If @a finished is @c false, the
    7936         machine will not call any framebuffer methods until
     7936        machine will not call any frame buffer methods until
    79377937        <link to="IDisplay::resizeCompleted()"/> is called.
    79387938
    79397939        Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
    79407940        <link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
    7941         this framebuffer must return exactly the same values as specified in the
     7941        this frame buffer must return exactly the same values as specified in the
    79427942        parameters of this method, after the resize is completed. If the
    79437943        indirect mode is chosen, these attributes must return values describing
    … …  
    79857985      <param name="finished" type="boolean" dir="return">
    79867986        <desc>
    7987           Can the VM start using the new framebuffer immediately
     7987          Can the VM start using the new frame buffer immediately
    79887988          after this method returns or it should wait for
    79897989          <link to="IDisplay::resizeCompleted()"/>.
    … …  
    80108010    <method name="videoModeSupported">
    80118011      <desc>
    8012         Returns whether the framebuffer implementation is willing to
     8012        Returns whether the frame buffer implementation is willing to
    80138013        support a given video mode. In case it is not able to render
    80148014        the video mode (or for some reason not willing), it should
    … …  
    80518051    <method name="getVisibleRegion">
    80528052      <desc>
    8053         Returns the visible region of this framebuffer.
     8053        Returns the visible region of this frame buffer.
    80548054
    80558055        If the @a rectangles parameter is <tt>NULL</tt> then the value of the
    … …  
    80818081    <method name="setVisibleRegion">
    80828082      <desc>
    8083         Suggests a new visible region to this framebuffer.  This region
     8083        Suggests a new visible region to this frame buffer.  This region
    80848084        represents the area of the VM display which is a union of regions of
    80858085        all top-level windows of the guest operating system running inside the
    … …  
    81238123    </desc>
    81248124    <attribute name="x" type="unsigned long" readonly="yes">
    8125       <desc>X position of the overlay, relative to the framebuffer.</desc>
     8125      <desc>X position of the overlay, relative to the frame buffer.</desc>
    81268126    </attribute>
    81278127
    81288128    <attribute name="y" type="unsigned long" readonly="yes">
    8129       <desc>Y position of the overlay, relative to the framebuffer.</desc>
     8129      <desc>Y position of the overlay, relative to the frame buffer.</desc>
    81308130    </attribute>
    81318131
    … …  
    81868186    <method name="setupInternalFramebuffer">
    81878187      <desc>
    8188         Prepares an internally managed framebuffer.
     8188        Prepares an internally managed frame buffer.
    81898189      </desc>
    81908190      <param name="depth" type="unsigned long" dir="in"/>
    … …  
    81938193    <method name="lockFramebuffer">
    81948194      <desc>
    8195         Requests access to the internal framebuffer.
     8195        Requests access to the internal frame buffer.
    81968196      </desc>
    81978197      <param name="address" type="octet" mod="ptr" dir="return"/>
    … …  
    82008200    <method name="unlockFramebuffer">
    82018201      <desc>
    8202         Releases access to the internal framebuffer.
     8202        Releases access to the internal frame buffer.
    82038203      </desc>
    82048204    </method>
    … …  
    82068206    <method name="registerExternalFramebuffer">
    82078207      <desc>
    8208         Registers an external framebuffer.
     8208        Registers an external frame buffer.
    82098209      </desc>
    82108210      <param name="framebuffer" type="IFramebuffer" dir="in"/>
    … …  
    90109010      <desc>
    90119011        Host USB port number the device is physically
    9012         coonected to.
     9012        connected to.
    90139013      </desc>
    90149014    </attribute>
    … …  
    91039103        </li>
    91049104        <li><i>Exact match</i>. Used to specify a single value for the given
    9105           device attribute. Any string that does't start with <tt>int:</tt>
     9105          device attribute. Any string that doesn't start with <tt>int:</tt>
    91069106          represents the exact match. String device attributes are compared to
    91079107          this string including case of symbols. Integer attributes are first
    … …  
    92109210      <desc>
    92119211       This is an advanced option for hiding one or more USB interfaces
    9212        from the guest. The value is a bitmask where the bits that are set
     9212       from the guest. The value is a bit mask where the bits that are set
    92139213       means the corresponding USB interface should be hidden, masked off
    92149214       if you like.
    … …  
    92379237      Once a supported USB device is attached to the host, global USB
    92389238      filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
    9239       either ignore the device, or put ot to #Held state, or do nothing. Unless
     9239      either ignore the device, or put it to #Held state, or do nothing. Unless
    92409240      the device is ignored by global filters, filters of all currently running
    92419241      guests (<link to="IUSBController::deviceFilters"/>) are activated that can
    … …  
    97849784    <method name="onSerialPortChange">
    97859785      <desc>
    9786         Triggered when settions of a serial port of the
     9786        Triggered when settings of a serial port of the
    97879787        associated virtual machine have changed.
    97889788      </desc>
    … …  
    98819881      <desc>
    98829882        Return a list of the guest properties matching a set of patterns along
    9883         with their values, timestamps and flags.
     9883        with their values, time stamps and flags.
    98849884      </desc>
    98859885      <param name="patterns" type="wstring" dir="in">
    … …  
    99039903      <param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
    99049904        <desc>
    9905           The timestamps of the properties returned.  The array entries match
     9905          The time stamps of the properties returned.  The array entries match
    99069906          the corresponding entries in the @a key array.
    99079907        </desc>
    … …  
    1031510315      <ul>
    1031610316        <li>
    10317           Obtain an instance of IPerfromanceCollector with
     10317          Obtain an instance of IPerformanceCollector with
    1031810318          <link to="IVirtualBox::performanceCollector" />
    1031910319        </li>
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette