| Index: ppapi/cpp/dev/var_array_dev.h
|
| diff --git a/ppapi/cpp/dev/var_array_dev.h b/ppapi/cpp/dev/var_array_dev.h
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..e11bd0a6699aba6517be96a4c4bbce6e61b2a185
|
| --- /dev/null
|
| +++ b/ppapi/cpp/dev/var_array_dev.h
|
| @@ -0,0 +1,84 @@
|
| +// Copyright (c) 2013 The Chromium Authors. All rights reserved.
|
| +// Use of this source code is governed by a BSD-style license that can be
|
| +// found in the LICENSE file.
|
| +
|
| +#ifndef PPAPI_CPP_DEV_VAR_ARRAY_DEV_H_
|
| +#define PPAPI_CPP_DEV_VAR_ARRAY_DEV_H_
|
| +
|
| +#include "ppapi/c/pp_bool.h"
|
| +#include "ppapi/c/pp_stdint.h"
|
| +#include "ppapi/cpp/var.h"
|
| +
|
| +/// @file
|
| +/// This file defines the API for interacting with array vars.
|
| +
|
| +namespace pp {
|
| +
|
| +class VarArray_Dev : public Var {
|
| + public:
|
| + /// Constructs a new array var.
|
| + VarArray_Dev();
|
| +
|
| + /// Contructs a <code>VarArray_Dev</code> given a var for which is_array() is
|
| + /// true. This will refer to the same array var, but allow you to access
|
| + /// methods specific to arrays.
|
| + ///
|
| + /// @param[in] var An array var.
|
| + explicit VarArray_Dev(const Var& var);
|
| +
|
| + /// Copy constructor.
|
| + VarArray_Dev(const VarArray_Dev& other);
|
| +
|
| + virtual ~VarArray_Dev();
|
| +
|
| + /// Assignment operator.
|
| + VarArray_Dev& operator=(const VarArray_Dev& other);
|
| +
|
| + /// The <code>Var</code> assignment operator is overridden here so that we can
|
| + /// check for assigning a non-array var to a <code>VarArray_Dev</code>.
|
| + ///
|
| + /// @param[in] other The array var to be assigned.
|
| + ///
|
| + /// @return The resulting <code>VarArray_Dev</code> (as a <code>Var</code>&).
|
| + virtual Var& operator=(const Var& other);
|
| +
|
| + /// Gets an element from the array.
|
| + ///
|
| + /// @param[in] index An index indicating which element to return.
|
| + ///
|
| + /// @return The element at the specified position. If <code>index</code> is
|
| + /// larger than or equal to the array length, an undefined var is returned.
|
| + Var Get(uint32_t index) const;
|
| +
|
| + /// Sets the value of an element in the array.
|
| + ///
|
| + /// @param[in] index An index indicating which element to modify. If
|
| + /// <code>index</code> is larger than or equal to the array length, the length
|
| + /// is updated to be <code>index</code> + 1. Any position in the array that
|
| + /// hasn't been set before is set to undefined, i.e., <code>PP_Var</code> of
|
| + /// type <code>PP_VARTYPE_UNDEFINED</code>.
|
| + /// @param[in] value The value to set.
|
| + ///
|
| + /// @return A <code>PP_Bool</code> indicating whether the operation succeeds.
|
| + PP_Bool Set(uint32_t index, const Var& value);
|
| +
|
| + /// Gets the array length.
|
| + ///
|
| + /// @return The array length.
|
| + uint32_t GetLength() const;
|
| +
|
| + /// Sets the array length.
|
| + ///
|
| + /// @param[in] length The new array length. If <code>length</code> is smaller
|
| + /// than its current value, the array is truncated to the new length; any
|
| + /// elements that no longer fit are removed. If <code>length</code> is larger
|
| + /// than its current value, undefined vars are appended to increase the array
|
| + /// to the specified length.
|
| + ///
|
| + /// @return A <code>PP_Bool</code> indicating whether the operation succeeds.
|
| + PP_Bool SetLength(uint32_t length);
|
| +};
|
| +
|
| +} // namespace pp
|
| +
|
| +#endif // PPAPI_CPP_DEV_VAR_ARRAY_DEV_H_
|
|
|