parse_detailed_name


Description:

[ Version ( since = "2.38" ) ]
public static bool parse_detailed_name (string detailed_name, out string action_name, out Variant? target_value) throws Error

Parses a detailed action name into its separate name and target components.

Detailed action names can have three formats.

The first format is used to represent an action name with no target value and consists of just an action name containing no whitespace nor the characters `:`, `(` or `)`. For example: `app.action`.

The second format is used to represent an action with a target value that is a non-empty string consisting only of alphanumerics, plus `-` and `.`. In that case, the action name and target value are separated by a double colon (`::`). For example: `app.action:GAction:target `.

The third format is used to represent an action with any type of target value, including strings. The target value follows the action name, surrounded in parens. For example: `app.action(42)`. The target value is parsed using parse. If a tuple-typed value is desired, it must be specified in the same way, resulting in two sets of parens, for example: `app.action((1,2,3))`. A string target can be specified this way as well: `app.action( 'target')`. For strings, this third format must be used if target value is empty or contains characters other than alphanumerics, `-` and `.`.

If this function returns true, a non-null value is guaranteed to be returned in action_name (if a pointer is passed in). A null value may still be returned in target_value, as the detailed_name may not contain a target.

If returned, the Variant in target_value is guaranteed to not be floating.

Parameters:

detailed_name

a detailed action name

action_name

the action name

target_value

the target value, or null for no target

Returns:

true if successful, else false with throws set