Chromium Embedded Framework (CEF)
126.2.0+g5c56e98+chromium-126.0.6478.62
|
Class used to create and/or parse command line arguments. More...
#include "include/cef_command_line.h"
Public Types | |
typedef std::vector< CefString > | ArgumentList |
typedef std::map< CefString, CefString > | SwitchMap |
Public Member Functions | |
virtual bool | IsValid ()=0 |
Returns true if this object is valid. More... | |
virtual bool | IsReadOnly ()=0 |
Returns true if the values of this object are read-only. More... | |
virtual CefRefPtr< CefCommandLine > | Copy ()=0 |
Returns a writable copy of this object. More... | |
virtual void | InitFromArgv (int argc, const char *const *argv)=0 |
Initialize the command line with the specified |argc| and |argv| values. More... | |
virtual void | InitFromString (const CefString &command_line)=0 |
Initialize the command line with the string returned by calling GetCommandLineW(). More... | |
virtual void | Reset ()=0 |
Reset the command-line switches and arguments but leave the program component unchanged. More... | |
virtual void | GetArgv (std::vector< CefString > &argv)=0 |
Retrieve the original command line string as a vector of strings. More... | |
virtual CefString | GetCommandLineString ()=0 |
Constructs and returns the represented command line string. More... | |
virtual CefString | GetProgram ()=0 |
Get the program part of the command line string (the first item). More... | |
virtual void | SetProgram (const CefString &program)=0 |
Set the program part of the command line string (the first item). More... | |
virtual bool | HasSwitches ()=0 |
Returns true if the command line has switches. More... | |
virtual bool | HasSwitch (const CefString &name)=0 |
Returns true if the command line contains the given switch. More... | |
virtual CefString | GetSwitchValue (const CefString &name)=0 |
Returns the value associated with the given switch. More... | |
virtual void | GetSwitches (SwitchMap &switches)=0 |
Returns the map of switch names and values. More... | |
virtual void | AppendSwitch (const CefString &name)=0 |
Add a switch to the end of the command line. More... | |
virtual void | AppendSwitchWithValue (const CefString &name, const CefString &value)=0 |
Add a switch with the specified value to the end of the command line. More... | |
virtual bool | HasArguments ()=0 |
True if there are remaining command line arguments. More... | |
virtual void | GetArguments (ArgumentList &arguments)=0 |
Get the remaining command line arguments. More... | |
virtual void | AppendArgument (const CefString &argument)=0 |
Add an argument to the end of the command line. More... | |
virtual void | PrependWrapper (const CefString &wrapper)=0 |
Insert a command before the current command. 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< CefCommandLine > | CreateCommandLine () |
Create a new CefCommandLine instance. More... | |
static CefRefPtr< CefCommandLine > | GetGlobalCommandLine () |
Returns the singleton global CefCommandLine object. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from CefBaseRefCounted | |
virtual | ~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 should be lowercase ASCII and will be converted to such if necessary. Switch values will retain the original case and UTF8 encoding. This class can be used before CefInitialize() is called.
typedef std::vector<CefString> CefCommandLine::ArgumentList |
typedef std::map<CefString, CefString> CefCommandLine::SwitchMap |
|
pure virtual |
Add an argument to the end of the command line.
|
pure virtual |
Add a switch to the end of the command line.
|
pure virtual |
Add a switch with the specified value to the end of the command line.
If the switch has no value pass an empty value string.
|
pure virtual |
Returns a writable copy of this object.
|
static |
Create a new CefCommandLine instance.
|
pure virtual |
Get the remaining command line arguments.
|
pure virtual |
Retrieve the original command line string as a vector of strings.
The argv array: { program, [(--|-|/)switch[=value]]*, [--], [argument]* }
|
pure virtual |
Constructs and returns the represented command line string.
Use this method cautiously because quoting behavior is unclear.
|
static |
Returns the singleton global CefCommandLine object.
The returned object will be read-only.
|
pure virtual |
Get the program part of the command line string (the first item).
|
pure virtual |
Returns the map of switch names and values.
If a switch has no value an empty string is returned.
Returns the value associated with the given switch.
If the switch has no value or isn't present this method returns the empty string.
|
pure virtual |
True if there are remaining command line arguments.
|
pure virtual |
Returns true if the command line contains the given switch.
|
pure virtual |
Returns true if the command line has switches.
|
pure virtual |
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.
|
pure virtual |
Initialize the command line with the string returned by calling GetCommandLineW().
This method is only supported on Windows.
|
pure virtual |
Returns true if the values of this object are read-only.
Some APIs may expose read-only objects.
|
pure virtual |
Returns true if this object is valid.
Do not call any other methods if this function returns false.
|
pure virtual |
Insert a command before the current command.
Common for debuggers, like "valgrind" or "gdb --args".
|
pure virtual |
Reset the command-line switches and arguments but leave the program component unchanged.
|
pure virtual |
Set the program part of the command line string (the first item).