kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Gui: Document ResolveMode directly.

Browse Source
This commit is contained in:
tritao
2025-02-05 13:13:58 +00:00
parent ae56e62049
commit ee078645d7
1 changed files with 4 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/Gui/Selection/Selection.h
View File

@@ -49,9 +49,13 @@ namespace Gui
{
enum class ResolveMode {
/// No resolve
NoResolve,
/// Sub-object with old style element name
OldStyleElement,
/// Sub-object with new style element name
NewStyleElement,
/// Resolve sub-object and follow link
FollowLink
};
@@ -227,9 +231,6 @@ public:
*
* @param attach: whether to attach this observer on construction
* @param resolve: sub-object resolving mode.
* 0 no resolve,
* 1 resolve sub-object with old style element name
* 2 resolve sub-object with new style element name
*/
explicit SelectionObserver(bool attach = true, ResolveMode resolve = ResolveMode::OldStyleElement);
/** Constructor
@@ -237,9 +238,6 @@ public:
* @param vp: filtering view object.
* @param attach: whether to attach this observer on construction
* @param resolve: sub-object resolving mode.
* 0 no resolve,
* 1 resolve sub-object with old style element name
* 2 resolve sub-object with new style element name
*
* Constructs an selection observer that receives only selection event of
* objects within the same document as the input view object.
@@ -452,9 +450,6 @@ public:
* empty vector is returned. If document name is "*", then all document is
* considered.
* @param resolve: sub-object resolving mode
* 0 no resolve,
* 1 resolve sub-object with old style element name
* 2 resolve sub-object with new style element name
* @param single: if set to true, then it will return an empty vector if
* there is more than one selections.
*
@@ -469,9 +464,6 @@ public:
* considered.
* @param typeId: specify the type of object to be returned.
* @param resolve: sub-object resolving mode.
* 0 no resolve,
* 1 resolve sub-object with old style element name
* 2 resolve sub-object with new style element name
* @param single: if set to true, then it will return an empty vector if
* there is more than one selections.
*
@@ -549,9 +541,6 @@ public:
* @param pDocName: optional filtering document, NULL for current active
* document
* @param resolve: sub-object resolving mode.
* 0 no resolve,
* 1 resolve sub-object with old style element name
* 2 resolve sub-object with new style element name
* @param index: optional position in the stack
*/
std::vector<Gui::SelectionObject> selStackGet(const char* pDocName=nullptr, ResolveMode resolve = ResolveMode::OldStyleElement, int index=0) const;