# eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.ProjectHelper

Module implementing the queues extension project helper.

### Global Attributes

None

### Classes

QueuesProjectHelper | Class implementing the queues extension project helper.

### Functions

None

## QueuesProjectHelper

Class implementing the queues extension project helper.

### Derived from

HgExtensionProjectHelper

### Class Attributes

None

### Class Methods

None

### Methods

QueuesProjectHelper | Constructor
__hgQueueActivateQueue | Private slot used to set the active queue.
__hgQueueCommit | Private slot to commit changes in the queue repository.
__hgQueueCreateQueue | Private slot used to create a new queue.
__hgQueueDeletePatch | Private slot used to delete a patch.
__hgQueueDeleteQueue | Private slot used to delete the reference to a queue.
__hgQueueFinishAppliedPatches | Private slot used to finish all applied patches.
__hgQueueFoldUnappliedPatches | Private slot used to fold patches into the current patch.
__hgQueueGotoPatch | Private slot used to push or pop patches until the a named one is at the top of the stack.
__hgQueueGotoPatchForced | Private slot used to push or pop patches until the a named one is at the top of the stack overwriting local changes.
__hgQueueGuardsDeactivate | Private slot used to deactivate all active guards.
__hgQueueGuardsDefine | Private slot used to define guards for the current or a named patch.
__hgQueueGuardsDropAll | Private slot used to drop all guards of the current or a named patch.
__hgQueueGuardsIdentifyActive | Private slot used to list all active guards.
__hgQueueGuardsList | Private slot used to list the guards for the current or a named patch.
__hgQueueGuardsListAll | Private slot used to list all guards of all patches.
__hgQueueGuardsSetActive | Private slot used to set the active guards.
__hgQueueInit | Private slot to initialize a new queue repository.
__hgQueueListPatches | Private slot used to show a list of applied and unapplied patches.
__hgQueueListQueues | Private slot used to list available queues.
__hgQueueNewPatch | Private slot used to create a new named patch.
__hgQueuePopAllPatches | Private slot used to pop all patches off the stack.
__hgQueuePopAllPatchesForced | Private slot used to pop all patches off the stack forgetting any local changes to patched files.
__hgQueuePopPatch | Private slot used to pop the current patch off the stack.
__hgQueuePopPatchForced | Private slot used to pop the current patch off the stack forgetting any local changes to patched files.
__hgQueuePopPatches | Private slot used to pop patches off the stack until a named one is at the top.
__hgQueuePopPatchesForced | Private slot used to pop patches off the stack until a named one is at the top forgetting any local changes to patched files.
__hgQueuePurgeQueue | Private slot used to delete the reference to a queue and remove the patch directory.
__hgQueuePushAllPatches | Private slot used to push all patches onto the stack.
__hgQueuePushAllPatchesForced | Private slot used to push all patches onto the stack on top of local changes.
__hgQueuePushPatch | Private slot used to push the next patch onto the stack.
__hgQueuePushPatchForced | Private slot used to push the next patch onto the stack on top of local changes.
__hgQueuePushPatches | Private slot used to push patches onto the stack until a named one is at the top.
__hgQueuePushPatchesForced | Private slot used to push patches onto the stack until a named one is at the top on top of local changes.
__hgQueuePushPopPatches | Private method to push patches onto the stack or pop patches off the stack.
__hgQueueRefreshPatch | Private slot used to refresh the current patch.
__hgQueueRefreshPatchMessage | Private slot used to refresh the current patch and its commit message.
__hgQueueRenamePatch | Private slot used to rename a patch.
__hgQueueRenameQueue | Private slot used to rename the active queue.
__hgQueueShowHeader | Private slot used to show the commit message of the current patch.
__hgQueueShowPatch | Private slot used to show the contents of the current patch.
__hgQueueStatus | Private slot to show the status of the queue repository.
__hgQueueSummary | Private slot to show a summary of the queue repository.
__initGuardsActions | Private method to generate the guards action objects.
__initPushPopActions | Private method to generate the push and pop action objects.
__initPushPopForceActions | Private method to generate the push and pop (force) action objects.
__initQueuesMgmtActions | Private method to generate the queues management action objects.
initActions | Public method to generate the action objects.
initMenu | Public method to generate the extension menu.
menuTitle | Public method to get the menu title.

### Static Methods

None

#### QueuesProjectHelper (Constructor)

QueuesProjectHelper()

Constructor

#### QueuesProjectHelper.__hgQueueActivateQueue

__hgQueueActivateQueue()

Private slot used to set the active queue.

#### QueuesProjectHelper.__hgQueueCommit

__hgQueueCommit()

Private slot to commit changes in the queue repository.

#### QueuesProjectHelper.__hgQueueCreateQueue

__hgQueueCreateQueue()

Private slot used to create a new queue.

#### QueuesProjectHelper.__hgQueueDeletePatch

__hgQueueDeletePatch()

Private slot used to delete a patch.

#### QueuesProjectHelper.__hgQueueDeleteQueue

__hgQueueDeleteQueue()

Private slot used to delete the reference to a queue.

#### QueuesProjectHelper.__hgQueueFinishAppliedPatches

__hgQueueFinishAppliedPatches()

Private slot used to finish all applied patches.

#### QueuesProjectHelper.__hgQueueFoldUnappliedPatches

__hgQueueFoldUnappliedPatches()

Private slot used to fold patches into the current patch.

#### QueuesProjectHelper.__hgQueueGotoPatch

__hgQueueGotoPatch()

Private slot used to push or pop patches until the a named one is at the top of the stack.

#### QueuesProjectHelper.__hgQueueGotoPatchForced

__hgQueueGotoPatchForced()

Private slot used to push or pop patches until the a named one is at the top of the stack overwriting local changes.

#### QueuesProjectHelper.__hgQueueGuardsDeactivate

__hgQueueGuardsDeactivate()

Private slot used to deactivate all active guards.

#### QueuesProjectHelper.__hgQueueGuardsDefine

__hgQueueGuardsDefine()

Private slot used to define guards for the current or a named patch.

#### QueuesProjectHelper.__hgQueueGuardsDropAll

__hgQueueGuardsDropAll()

Private slot used to drop all guards of the current or a named patch.

#### QueuesProjectHelper.__hgQueueGuardsIdentifyActive

__hgQueueGuardsIdentifyActive()

Private slot used to list all active guards.

#### QueuesProjectHelper.__hgQueueGuardsList

__hgQueueGuardsList()

Private slot used to list the guards for the current or a named patch.

#### QueuesProjectHelper.__hgQueueGuardsListAll

__hgQueueGuardsListAll()

Private slot used to list all guards of all patches.

#### QueuesProjectHelper.__hgQueueGuardsSetActive

__hgQueueGuardsSetActive()

Private slot used to set the active guards.

#### QueuesProjectHelper.__hgQueueInit

__hgQueueInit()

Private slot to initialize a new queue repository.

#### QueuesProjectHelper.__hgQueueListPatches

__hgQueueListPatches()

Private slot used to show a list of applied and unapplied patches.

#### QueuesProjectHelper.__hgQueueListQueues

__hgQueueListQueues()

Private slot used to list available queues.

#### QueuesProjectHelper.__hgQueueNewPatch

__hgQueueNewPatch()

Private slot used to create a new named patch.

#### QueuesProjectHelper.__hgQueuePopAllPatches

__hgQueuePopAllPatches()

Private slot used to pop all patches off the stack.

#### QueuesProjectHelper.__hgQueuePopAllPatchesForced

__hgQueuePopAllPatchesForced()

Private slot used to pop all patches off the stack forgetting any local changes to patched files.

#### QueuesProjectHelper.__hgQueuePopPatch

__hgQueuePopPatch()

Private slot used to pop the current patch off the stack.

#### QueuesProjectHelper.__hgQueuePopPatchForced

__hgQueuePopPatchForced()

Private slot used to pop the current patch off the stack forgetting any local changes to patched files.

#### QueuesProjectHelper.__hgQueuePopPatches

__hgQueuePopPatches()

Private slot used to pop patches off the stack until a named one is at the top.

#### QueuesProjectHelper.__hgQueuePopPatchesForced

__hgQueuePopPatchesForced()

Private slot used to pop patches off the stack until a named one is at the top forgetting any local changes to patched files.

#### QueuesProjectHelper.__hgQueuePurgeQueue

__hgQueuePurgeQueue()

Private slot used to delete the reference to a queue and remove the patch directory.

#### QueuesProjectHelper.__hgQueuePushAllPatches

__hgQueuePushAllPatches()

Private slot used to push all patches onto the stack.

#### QueuesProjectHelper.__hgQueuePushAllPatchesForced

__hgQueuePushAllPatchesForced()

Private slot used to push all patches onto the stack on top of local changes.

#### QueuesProjectHelper.__hgQueuePushPatch

__hgQueuePushPatch()

Private slot used to push the next patch onto the stack.

#### QueuesProjectHelper.__hgQueuePushPatchForced

__hgQueuePushPatchForced()

Private slot used to push the next patch onto the stack on top of local changes.

#### QueuesProjectHelper.__hgQueuePushPatches

__hgQueuePushPatches()

Private slot used to push patches onto the stack until a named one is at the top.

#### QueuesProjectHelper.__hgQueuePushPatchesForced

__hgQueuePushPatchesForced()

Private slot used to push patches onto the stack until a named one is at the top on top of local changes.

#### QueuesProjectHelper.__hgQueuePushPopPatches

__hgQueuePushPopPatches(name, operation, doAll=False, named=False, force=False)

Private method to push patches onto the stack or pop patches off the stack.

name
  file/directory name (string)
operation
  operation type to be performed (Queues.POP, Queues.PUSH, Queues.GOTO)
doAll=
  flag indicating to push/pop all (boolean)
named=
  flag indicating to push/pop until a named patch is at the top of the stack (boolean)
force=
  flag indicating a forceful pop (boolean)

#### QueuesProjectHelper.__hgQueueRefreshPatch

__hgQueueRefreshPatch()

Private slot used to refresh the current patch.

#### QueuesProjectHelper.__hgQueueRefreshPatchMessage

__hgQueueRefreshPatchMessage()

Private slot used to refresh the current patch and its commit message.

#### QueuesProjectHelper.__hgQueueRenamePatch

__hgQueueRenamePatch()

Private slot used to rename a patch.

#### QueuesProjectHelper.__hgQueueRenameQueue

__hgQueueRenameQueue()

Private slot used to rename the active queue.

#### QueuesProjectHelper.__hgQueueShowHeader

__hgQueueShowHeader()

Private slot used to show the commit message of the current patch.

#### QueuesProjectHelper.__hgQueueShowPatch

__hgQueueShowPatch()

Private slot used to show the contents of the current patch.

#### QueuesProjectHelper.__hgQueueStatus

__hgQueueStatus()

Private slot to show the status of the queue repository.

#### QueuesProjectHelper.__hgQueueSummary

__hgQueueSummary()

Private slot to show a summary of the queue repository.

#### QueuesProjectHelper.__initGuardsActions

__initGuardsActions()

Private method to generate the guards action objects.

#### QueuesProjectHelper.__initPushPopActions

__initPushPopActions()

Private method to generate the push and pop action objects.

#### QueuesProjectHelper.__initPushPopForceActions

__initPushPopForceActions()

Private method to generate the push and pop (force) action objects.

#### QueuesProjectHelper.__initQueuesMgmtActions

__initQueuesMgmtActions()

Private method to generate the queues management action objects.

#### QueuesProjectHelper.initActions

initActions()

Public method to generate the action objects.

#### QueuesProjectHelper.initMenu

initMenu(mainMenu)

Public method to generate the extension menu.

mainMenu
  reference to the main menu (QMenu)

Returns:
  populated menu (QMenu)

#### QueuesProjectHelper.menuTitle

menuTitle()

Public method to get the menu title.

Returns:
  title of the menu (string)

Up