ScriptSvnUIServices¶
- class ScriptSvnUIServices.SvnUIServices¶
Bases:
object
Contains several UI related services. The SvnIntegration.plugin provides a system instance with the type guid 21662EFC-3501-4e14-9FC3-F158E38351B2 for this interface.
- ShowLog(owner, objectId)¶
Opens the subversion log window.
- Parameters:
owner (
Win32Window
) – The owner.objectId (
SvnObjectId
) – The object id.
- SelectRevision(owner, url)¶
Opens the select revision dialog.
- Parameters:
owner (
Win32Window
) – The owner.url (
Uri
) – The remote url.
- Return type:
int
- Returns:
The subversion revision number.
- CreateSvnMessageViewReporter(stName)¶
Creates a SVN message view reporter.
- Parameters:
stName (str) – Name of the action.
- Return type:
SvnReporter
- Returns:
The message view reporter.
- CreateSvnCheckMessageViewReporter(stName)¶
Creates a SVN check message view reporter.
- Parameters:
stName (str) – Name of the action.
- Return type:
SvnReporter
- Returns:
The message view reporter.
- BrowseRepository(owner, url, revision, filterCache)¶
Opens the repository browser window.
- Parameters:
owner (
Win32Window
) – The owner window.url (
Uri
) – The URL.revision (
SvnRevision
) – The revision.filterCache (
SvnAsynchroneousAcceptFilterCache
) – The OK button is only enabled if this filter returns true for the selected URL.
- Return type:
DialogResult
- Returns:
DialogResult.OK if the user pressed OK.
filter disables the OK button. If the filter calls nothing, the url is not accepted with a generic error message. If you really want unfiltered URLs, pass a filter which always calls accept. Uncaught exceptions also count as Deny, with the exception message as diagnostics message.
Beware that BrowseRepository can call the acceptedUrlFilter in background threads, so if you call into the object manager or interact with the UI, you will need to use
Engine
.InvokeInPrimaryThread or similar means.
- BrowseRepositoryFixedRevision(owner, url, revision, acceptedUrlFilter)¶
Opens the repository browser window, with a fixed revision.
- Parameters:
owner (
Win32Window
) – The owner window.url (
Uri
) – The URL.revision (
SvnRevision
) – The revision (which cannot be changed).acceptedUrlFilter (
SvnUrlAcceptFilterArgs
) – The OK button is only enabled if this filter returns true for the selected URL.
- Return type:
DialogResult
- Returns:
DialogResult.OK if the user pressed OK.
filter disables the OK button. If the filter calls nothing, the url is not accepted with a generic error message. If you really want unfiltered URLs, pass a filter which always calls accept. Uncaught exceptions also count as Deny, with the exception message as diagnostics message.
Beware that BrowseRepository can call the acceptedUrlFilter in background threads, so if you call into the object manager or interact with the UI, you will need to use
Engine
.InvokeInPrimaryThread or similar means.
- SelectRevisionRanges(owner, url)¶
Opens the select revision dialog.
- Parameters:
owner (
Win32Window
) – The owner.url (
Uri
) – The remote url.
- Return type:
str
- Returns:
The selected subversion revision ranges, like: 4-7,9,11,15-19
- GetDecorationIcon()¶
Gets the status decoration icon for the given object ID, as it would be displayed in the navigator control.
- Parameters:
objectId (
SvnObjectId
) – the object id of the object in question. This object id must relate to the local project / working copy, we cannot get status decorations for remote objects.- Return type:
Icon
- Returns:
The Icon, or
None
if no Icon could be found.
- Compare(owner, leftObjectId, leftRevision, rightObjectId, rightRevision, showSingleSided, showMarkAsResolvedButton=False)¶
Opens the compare window for a specific object.
- Parameters:
owner (
Win32Window
) – The owner.leftObjectId (
SvnObjectId
) – The left object id.leftRevision (
SvnRevision
) – The left revision.rightObjectId (
SvnObjectId
) – The right object id.rightRevision (
SvnRevision
) – The right revision.showSingleSided (bool) – If set to
True
, added or removed objects are shown in a single read-only editor.showMarkAsResolvedButton (bool) – If set to
True
the Mark as Resolved button will be visible for conflict cases.
- Return type:
bool
- Returns:
True if the user has closed the Dialog with OK.
- CompareInView(owner, leftUrl, leftRevision, rightUrl, rightRevision, showSingleSided)¶
Opens the compare
View
for two objects of different URLs. This may hapen e. G. when an object is copied and modified in the same commit, and we need to compare it against the previous state. This feature is available since development system version 3.5.12.10.- Parameters:
owner (
Win32Window
) – The owner.leftUrl (
Uri
) – The object Url.leftRevision (
SvnRevision
) – The left revision.rightUrl (
Uri
) – The object Url.rightRevision (
SvnRevision
) – The right revision.showSingleSided (bool) – If set to
True
, added or removed objects are shown in a single read-only editor.
- ShowLogView()¶
Opens the subversion log
View
.- Parameters:
objectId (
SvnObjectId
) – The object id.
- class ScriptSvnUIServices.SvnUrlAcceptFilterArgs¶
Bases:
object
Arguments passed to an Url Accept filter.
- property Url¶
Gets the URL which is to be accepted.
- Return type:
Uri
- property Revision¶
Gets the revision which is to be accepted.
- Return type:
SvnRevision
- Accept(stDescription)¶
Accepts this url, and supplies a human readable (localized) description of the current url.
- Parameters:
stDescription (str) – The description.
- Deny(stReason)¶
Denies the specified url, and supplies a human readable (localized) diagnostics message.
- Parameters:
stReason (str) – The reason.
- class ScriptSvnUIServices.SvnUrlAcceptFilterResult¶
Bases:
object
Provides the result of an Url Accept filter check.
- property Accepted¶
- Return type:
bool
- Returns:
True
, if the Url was accepted
- class ScriptSvnUIServices.SvnCheckOutControl¶
Bases:
object
Control used for the Checkout Dialog and the Checkout Action in the test driver.
is provided via the TypeGuid 135bd384-f5fd-462a-9a21-9d735310eb70.
- AcceptStateChanged()¶
[EventHandler]
- property AcceptState¶
- Return type:
bool
- property RepositoryUrl¶
- Return type:
Uri
- property Revision¶
- Return type:
SvnRevision
- property Target¶
- Return type:
SvnUrlTarget
- property LocalProjectFilePath¶
- Return type:
str
- property LocalProjectName¶
- Return type:
str
- property AsLibrary¶
Gets or sets a value indicating whether the project is checked out as library.
- Return type:
bool
- Returns:
True
if the project should be checked out as library; otherwise,False
.
- property OmitExternals¶
- Return type:
bool
- property RepositoryUrlControl¶
- Return type:
- SetAssociatedOnlineHelpTopic(keword: Optional[str] = None)¶
Sets or resets the associated online help topic. Use this when embedding the control somewhere which is not the original checkout dialog.
- Parameters:
topic (str) – The online help topic URL.
keword (str) – The online help keyword.
- property AutodetectProjectType¶
Gets or sets a value indicating whether the project type (library or project) is automatically detected.
- Return type:
bool
- Returns:
True
if the project type is autodetected; otherwise,False
.
- class ScriptSvnUIServices.SvnRepositoryUrlControl¶
Bases:
object
Control used for repository targets (URL and Revision).
- StatusUpdated(eventargs: AcceptFilterUpdateEventArgs)¶
[Delegate] This event is fired whenever the status is updated.
- TargetChanged(eventargs: TargetChangedEventArgs)¶
[Delegate]
- property FixRevision¶
- Return type:
SvnRevision
- property ShowBrowserButton¶
- Return type:
bool
- property IsFixRevision¶
- Return type:
bool
- property Accepted¶
- Return type:
bool
- property Url¶
- Return type:
Uri
- property Revision¶
- Return type:
SvnRevision
- property Target¶
- Return type:
SvnUrlTarget
- AcceptInputToUrlHistory()¶
- property AcceptFilterCache¶
- Return type:
SvnAsynchroneousAcceptFilterCache
- property AcceptedTarget¶
- Return type:
SvnUrlTarget
- property AdditionallyAllowedTextValidator¶
Use this property to allow additional texts (e. G. test manager {expressions}) to be entered in the control. Use
RawUrlText
to get the raw text of the url in this case.- Return type:
- property RawUrlText¶
Use this property to get the raw text if
AdditionallyAllowedTextValidator
is used.- Return type:
str
- SetAssociatedOnlineHelpTopic(topic: Optional[str] = None, keword: Optional[str] = None)¶
Sets or resets the associated online help topic. Use this when embedding the control somewhere where the surrounding control does not provide any useful online help.
- Parameters:
topic (str) – The online help topic URL.
keword (str) – The online help keyword.
- ScriptSvnUIServices.AdditionallyAllowedTextValidator(self, stUriCandidate, bAccepted, stExplanation)¶
- Parameters:
stUriCandidate (str) –
bAccepted (bool) –
stExplanation (str) –