Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 3.3578.1860.g36610bd
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefCommandLine

CefBaseRefCounted
   |
   +--CefCommandLine

   in cef_command_line.h

class CefCommandLine
extends CefBaseRefCounted

Class used to create and/or parse command line arguments. Arguments with '--', '-' and, on Windows, '/' prefixes are considered switches. Switches will always precede any arguments without switch prefixes. Switches can optionally have a value specified using the '=' delimiter (e.g. "-switch=value"). An argument of "--" will terminate switch parsing with all subsequent tokens, regardless of prefix, being interpreted as non-switch arguments. Switch names are considered case-insensitive. This class can be used before CefInitialize() is called.


Inner Classes, Typedefs, and Enums
typedef CefCommandLine::ArgumentList
          
typedef CefCommandLine::SwitchMap
          
 
Method Summary
 virtual void AppendArgument( const CefString& argument )= 0
          Add an argument to the end of the command line.
 virtual void AppendSwitch( const CefString& name )= 0
          Add a switch to the end of the command line.
 virtual void AppendSwitchWithValue( const CefString& name, const CefString& value )= 0
          Add a switch with the specified value to the end of the command line.
 virtual CefRefPtr< CefCommandLine > Copy()= 0
          Returns a writable copy of this object.
 static CefRefPtr< CefCommandLine > CreateCommandLine()
          Create a new CefCommandLine instance.
 virtual void GetArguments( CefCommandLine::ArgumentList& arguments )= 0
          Get the remaining command line arguments.
 virtual void GetArgv( std::vector< CefString >& argv )= 0
          Retrieve the original command line string as a vector of strings.
 virtual CefString GetCommandLineString()= 0
          Constructs and returns the represented command line string.
 static CefRefPtr< CefCommandLine > GetGlobalCommandLine()
          Returns the singleton global CefCommandLine object.
 virtual CefString GetProgram()= 0
          Get the program part of the command line string (the first item).
 virtual void GetSwitches( CefCommandLine::SwitchMap& switches )= 0
          Returns the map of switch names and values.
 virtual CefString GetSwitchValue( const CefString& name )= 0
          Returns the value associated with the given switch.
 virtual bool HasArguments()= 0
          True if there are remaining command line arguments.
 virtual bool HasSwitch( const CefString& name )= 0
          Returns true if the command line contains the given switch.
 virtual bool HasSwitches()= 0
          Returns true if the command line has switches.
 virtual void InitFromArgv( int argc, const char* const* argv )= 0
          Initialize the command line with the specified |argc| and |argv| values.
 virtual void InitFromString( const CefString& command_line )= 0
          Initialize the command line with the string returned by calling GetCommandLineW().
 virtual bool IsReadOnly()= 0
          Returns true if the values of this object are read-only.
 virtual bool IsValid()= 0
          Returns true if this object is valid.
 virtual void PrependWrapper( const CefString& wrapper )= 0
          Insert a command before the current command.
 virtual void Reset()= 0
          Reset the command-line switches and arguments but leave the program component unchanged.
 virtual void SetProgram( const CefString& program )= 0
          Set the program part of the command line string (the first item).
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

AppendArgument

public virtual void AppendArgument( const CefString& argument )= 0;
Add an argument to the end of the command line.

AppendSwitch

public virtual void AppendSwitch( const CefString& name )= 0;
Add a switch to the end of the command line. If the switch has no value pass an empty value string.

AppendSwitchWithValue

public virtual void AppendSwitchWithValue( const CefString& name, const CefString& value )= 0;
Add a switch with the specified value to the end of the command line.

Copy

public virtual CefRefPtr< CefCommandLine > Copy()= 0;
Returns a writable copy of this object.

CreateCommandLine

public static CefRefPtr< CefCommandLine > CreateCommandLine();
Create a new CefCommandLine instance.

GetArguments

public virtual void GetArguments( CefCommandLine::ArgumentList& arguments )= 0;
Get the remaining command line arguments.

GetArgv

public virtual void GetArgv( std::vector< CefString >& argv )= 0;
Retrieve the original command line string as a vector of strings. The argv array: { program, [(--|-|/)switch[=value]]*, [--], [argument]* }

GetCommandLineString

public virtual CefString GetCommandLineString()= 0;
Constructs and returns the represented command line string. Use this method cautiously because quoting behavior is unclear.

GetGlobalCommandLine

public static CefRefPtr< CefCommandLine > GetGlobalCommandLine();
Returns the singleton global CefCommandLine object. The returned object will be read-only.

GetProgram

public virtual CefString GetProgram()= 0;
Get the program part of the command line string (the first item).

GetSwitches

public virtual void GetSwitches( CefCommandLine::SwitchMap& switches )= 0;
Returns the map of switch names and values. If a switch has no value an empty string is returned.

GetSwitchValue

public virtual CefString GetSwitchValue( const CefString& name )= 0;
Returns the value associated with the given switch. If the switch has no value or isn't present this method returns the empty string.

HasArguments

public virtual bool HasArguments()= 0;
True if there are remaining command line arguments.

HasSwitch

public virtual bool HasSwitch( const CefString& name )= 0;
Returns true if the command line contains the given switch.

HasSwitches

public virtual bool HasSwitches()= 0;
Returns true if the command line has switches.

InitFromArgv

public virtual void InitFromArgv( int argc, const char* const* argv )= 0;
Initialize the command line with the specified |argc| and |argv| values. The first argument must be the name of the program. This method is only supported on non-Windows platforms.

InitFromString

public virtual void InitFromString( const CefString& command_line )= 0;
Initialize the command line with the string returned by calling GetCommandLineW(). This method is only supported on Windows.

IsReadOnly

public virtual bool IsReadOnly()= 0;
Returns true if the values of this object are read-only. Some APIs may expose read-only objects.

IsValid

public virtual bool IsValid()= 0;
Returns true if this object is valid. Do not call any other methods if this function returns false.

PrependWrapper

public virtual void PrependWrapper( const CefString& wrapper )= 0;
Insert a command before the current command. Common for debuggers, like "valgrind" or "gdb --args".

Reset

public virtual void Reset()= 0;
Reset the command-line switches and arguments but leave the program component unchanged.

SetProgram

public virtual void SetProgram( const CefString& program )= 0;
Set the program part of the command line string (the first item).

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 3.3578.1860.g36610bd
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt