Class representing a list value. More...

#include "include/cef_values.h"

Inheritance diagram for CefListValue:

Public Member Functions
virtual bool	IsValid ()=0
	Returns true if this object is valid. More...

virtual bool	IsOwned ()=0
	Returns true if this object is currently owned by another object. More...

virtual bool	IsReadOnly ()=0
	Returns true if the values of this object are read-only. More...

virtual bool	IsSame (CefRefPtr< CefListValue > that)=0
	Returns true if this object and \|that\| object have the same underlying data. More...

virtual bool	IsEqual (CefRefPtr< CefListValue > that)=0
	Returns true if this object and \|that\| object have an equivalent underlying value but are not necessarily the same object. More...

virtual CefRefPtr< CefListValue >	Copy ()=0
	Returns a writable copy of this object. More...

virtual bool	SetSize (size_t size)=0
	Sets the number of values. More...

virtual size_t	GetSize ()=0
	Returns the number of values. More...

virtual bool	Clear ()=0
	Removes all values. More...

virtual bool	Remove (size_t index)=0
	Removes the value at the specified index. More...

virtual CefValueType	GetType (size_t index)=0
	Returns the value type at the specified index. More...

virtual CefRefPtr< CefValue >	GetValue (size_t index)=0
	Returns the value at the specified index. More...

virtual bool	GetBool (size_t index)=0
	Returns the value at the specified index as type bool. More...

virtual int	GetInt (size_t index)=0
	Returns the value at the specified index as type int. More...

virtual double	GetDouble (size_t index)=0
	Returns the value at the specified index as type double. More...

virtual CefString	GetString (size_t index)=0
	Returns the value at the specified index as type string. More...

virtual CefRefPtr< CefBinaryValue >	GetBinary (size_t index)=0
	Returns the value at the specified index as type binary. More...

virtual CefRefPtr< CefDictionaryValue >	GetDictionary (size_t index)=0
	Returns the value at the specified index as type dictionary. More...

virtual CefRefPtr< CefListValue >	GetList (size_t index)=0
	Returns the value at the specified index as type list. More...

virtual bool	SetValue (size_t index, CefRefPtr< CefValue > value)=0
	Sets the value at the specified index. More...

virtual bool	SetNull (size_t index)=0
	Sets the value at the specified index as type null. More...

virtual bool	SetBool (size_t index, bool value)=0
	Sets the value at the specified index as type bool. More...

virtual bool	SetInt (size_t index, int value)=0
	Sets the value at the specified index as type int. More...

virtual bool	SetDouble (size_t index, double value)=0
	Sets the value at the specified index as type double. More...

virtual bool	SetString (size_t index, const CefString &value)=0
	Sets the value at the specified index as type string. More...

virtual bool	SetBinary (size_t index, CefRefPtr< CefBinaryValue > value)=0
	Sets the value at the specified index as type binary. More...

virtual bool	SetDictionary (size_t index, CefRefPtr< CefDictionaryValue > value)=0
	Sets the value at the specified index as type dict. More...

virtual bool	SetList (size_t index, CefRefPtr< CefListValue > value)=0
	Sets the value at the specified index as type list. More...

Public Member Functions inherited from CefBaseRefCounted
virtual void	AddRef () const =0
	Called to increment the reference count for the object. More...

virtual bool	Release () const =0
	Called to decrement the reference count for the object. More...

virtual bool	HasOneRef () const =0
	Returns true if the reference count is 1. More...

virtual bool	HasAtLeastOneRef () const =0
	Returns true if the reference count is at least 1. More...

Static Public Member Functions
static CefRefPtr< CefListValue >	Create ()
	Creates a new object that is not owned by any other object. More...

Additional Inherited Members
Protected Member Functions inherited from CefBaseRefCounted
virtual	~CefBaseRefCounted ()

Detailed Description

Class representing a list value.

Can be used on any process and thread.

Member Function Documentation

◆ Clear()

virtual bool CefListValue::Clear ( )

pure virtual

Removes all values.

Returns true on success.

◆ Copy()

virtual CefRefPtr<CefListValue> CefListValue::Copy ( )

pure virtual

Returns a writable copy of this object.

◆ Create()

static CefRefPtr<CefListValue> CefListValue::Create ( )

static

Creates a new object that is not owned by any other object.

◆ GetBinary()

virtual CefRefPtr<CefBinaryValue> CefListValue::GetBinary ( size_t index )

pure virtual

Returns the value at the specified index as type binary.

The returned value will reference existing data.

◆ GetBool()

virtual bool CefListValue::GetBool ( size_t index )

pure virtual

Returns the value at the specified index as type bool.

◆ GetDictionary()

virtual CefRefPtr<CefDictionaryValue> CefListValue::GetDictionary ( size_t index )

pure virtual

Returns the value at the specified index as type dictionary.

The returned value will reference existing data and modifications to the value will modify this object.

◆ GetDouble()

virtual double CefListValue::GetDouble ( size_t index )

pure virtual

Returns the value at the specified index as type double.

◆ GetInt()

virtual int CefListValue::GetInt ( size_t index )

pure virtual

Returns the value at the specified index as type int.

◆ GetList()

virtual CefRefPtr<CefListValue> CefListValue::GetList ( size_t index )

pure virtual

Returns the value at the specified index as type list.

The returned value will reference existing data and modifications to the value will modify this object.

◆ GetSize()

virtual size_t CefListValue::GetSize ( )

pure virtual

Returns the number of values.

◆ GetString()

virtual CefString CefListValue::GetString ( size_t index )

pure virtual

Returns the value at the specified index as type string.

◆ GetType()

virtual CefValueType CefListValue::GetType ( size_t index )

pure virtual

Returns the value type at the specified index.

◆ GetValue()

virtual CefRefPtr<CefValue> CefListValue::GetValue ( size_t index )

pure virtual

Returns the value at the specified index.

For simple types the returned value will copy existing data and modifications to the value will not modify this object. For complex types (binary, dictionary and list) the returned value will reference existing data and modifications to the value will modify this object.

◆ IsEqual()

virtual bool CefListValue::IsEqual ( CefRefPtr< CefListValue > that )

pure virtual

Returns true if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

◆ IsOwned()

virtual bool CefListValue::IsOwned ( )

pure virtual

Returns true if this object is currently owned by another object.

◆ IsReadOnly()

virtual bool CefListValue::IsReadOnly ( )

pure virtual

Returns true if the values of this object are read-only.

Some APIs may expose read-only objects.

◆ IsSame()

virtual bool CefListValue::IsSame ( CefRefPtr< CefListValue > that )

pure virtual

Returns true if this object and |that| object have the same underlying data.

If true modifications to this object will also affect |that| object and vice-versa.

◆ IsValid()

virtual bool CefListValue::IsValid ( )

pure virtual

Returns true if this object is valid.

This object may become invalid if the underlying data is owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. Do not call any other methods if this method returns false.

◆ Remove()

virtual bool CefListValue::Remove ( size_t index )

pure virtual

Removes the value at the specified index.

◆ SetBinary()

virtual bool CefListValue::SetBinary	(	size_t	index,
		CefRefPtr< CefBinaryValue >	value
	)

pure virtual

Sets the value at the specified index as type binary.

◆ SetBool()

virtual bool CefListValue::SetBool	(	size_t	index,
		bool	value
	)

pure virtual

Sets the value at the specified index as type bool.

Returns true if the value was set successfully.

◆ SetDictionary()

virtual bool CefListValue::SetDictionary	(	size_t	index,
		CefRefPtr< CefDictionaryValue >	value
	)

pure virtual

Sets the value at the specified index as type dict.

◆ SetDouble()

virtual bool CefListValue::SetDouble	(	size_t	index,
		double	value
	)

pure virtual

Sets the value at the specified index as type double.

Returns true if the value was set successfully.

◆ SetInt()

virtual bool CefListValue::SetInt	(	size_t	index,
		int	value
	)

pure virtual

Sets the value at the specified index as type int.

Returns true if the value was set successfully.

◆ SetList()

virtual bool CefListValue::SetList	(	size_t	index,
		CefRefPtr< CefListValue >	value
	)

pure virtual

Sets the value at the specified index as type list.

◆ SetNull()

virtual bool CefListValue::SetNull ( size_t index )

pure virtual

Sets the value at the specified index as type null.

Returns true if the value was set successfully.

◆ SetSize()

virtual bool CefListValue::SetSize ( size_t size )

pure virtual

Sets the number of values.

If the number of values is expanded all new value slots will default to type null. Returns true on success.

◆ SetString()

virtual bool CefListValue::SetString	(	size_t	index,
		const CefString &	value
	)

pure virtual

Sets the value at the specified index as type string.

Returns true if the value was set successfully.

◆ SetValue()

virtual bool CefListValue::SetValue	(	size_t	index,
		CefRefPtr< CefValue >	value
	)

pure virtual

Sets the value at the specified index.

The documentation for this class was generated from the following file:

include/cef_values.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Clear()

◆ Copy()

◆ Create()

◆ GetBinary()

◆ GetBool()

◆ GetDictionary()

◆ GetDouble()

◆ GetInt()

◆ GetList()

◆ GetSize()

◆ GetString()

◆ GetType()

◆ GetValue()

◆ IsEqual()

◆ IsOwned()

◆ IsReadOnly()

◆ IsSame()

◆ IsValid()

◆ Remove()

◆ SetBinary()

◆ SetBool()

◆ SetDictionary()

◆ SetDouble()

◆ SetInt()

◆ SetList()

◆ SetNull()

◆ SetSize()

◆ SetString()

◆ SetValue()