Rename 'name' member of ActionDescription to 'customName'

* This is a deliberate break of compatibility since the field is now often
  empty, for non-markers. This means code will get a more explicit error when
  the name is being referenced, so it can be updated to fetch the name it needs
  as needed.
This commit is contained in:
baldurk
2021-07-01 15:15:05 +01:00
parent 7149302680
commit d0accc409b
36 changed files with 373 additions and 275 deletions
+12
View File
@@ -297,6 +297,18 @@ If no capture is loaded or the EID doesn't correspond to a known event, ``None``
)");
virtual const ActionDescription *GetActionForEID(uint32_t eventId) = 0;
DOCUMENT(R"(Returns the formatted name of an event according to the current settings, whether
that be a custom name or an auto-generated name with/without parameter names.
If no capture is loaded or the EID doesn't correspond to a known event, an empty string will be
returned.
:param int eventId: The EID to look up.
:return: The formatted name of the specified event, or ``None`` if no such EID exists.
:rtype: str
)");
virtual rdcstr GetEventName(uint32_t eventId) = 0;
DOCUMENT(R"(Determines if a given EID is visible with the current filters applied to the event
browser.