Zuble QML Types   |  Zuble C++ Classes   |  Table of Contents

ContentPane QML Type

The container of workpads, it displays the active workpad and controls workpad loading and unloading. More...

Import Statement: import workspace .

Properties

Signals

Methods

Detailed Description

The content pane takes up the majority of the screen area and displays the active workpad being viewed.

ContentPane is the visual parent of all workpads. Multiple workpads can be opened at one time but only one can be active at a time. The active workpad takes up the right column of ContentPane. A selector control (list of buttons) that allows switching between workpads occupies the left column.

Property Documentation

contextLabels : var

The container of the menu labels for switching between toolbox menu items, a ContextLabels object.


contextPane : var

The container of the toolbox menu items, a ContextPane object.


partition : real

Portion of the screen used by something? TBD: NEED THIS?


Signal Documentation

menuActionReceived(string = contentName, string = menuName)

Sent when user has selected an action in the toolbox menu


menuModelReady()

Sent when the XmlListModel of tool menu metadata has been loaded


Method Documentation

addWorkpad( = workpadProperties, = saveToSettings)

Adds the specified workpad to the content view. workpad IDs must be unique


closeCurrentWorkpad()

Calls closeWorkpad() function for the current workpad being viewed.


closeModalMenu()

Closes the modal menu that was displayed by calling displayModalMenuCmd() function


closeWorkpad( = contentID)

Removes the workpad from the ContentPane and then destroys it.


displayMenuCmd( = menuName, = payload)

Sends a menu command from the current content view to the specified menu, then activates the specified menu


displayModalMenuCmd( = menuName, = payload)

Sends a menu command from the current workpad to the specified menu, then hides all modeless menu items and displays the specified menu item modally


getCurrentWorkpad()

Returns ZWorkpad object for currently displayed workpad, or undefined if no such object exists


getCurrentWorkpadID()

Returns the content ID of the currently displayed workpad, or undefined if no such object exists


getCurrentWorkpadName()

Returns content name of the current workpad, or undefined if no such object exists


getWorkpadConfig( = contentID)

Returns the workpad's XML configuration as a JSON object, or undefined if no such object exists


getWorkpadObjectByID( = contentID)

Returns ZWorkpad object for the specified workpad, or undefined if no such object exists


hideMenu()

Hide the tool menu


initActionPanel( = buttonOpen)

Initializes the action tray of the context labels from data in the workpad configuration


populateWorkspace()

Populates the workspace from either the persistent workspace settings or from the zblconfig.xml file <workspace> element if no persistent workpad settings exist.


processMenuAction( = contentName, = menuName, = payload)

Called by toolbox menu items when user actions occur in the menus. Pushes payload onto specified mailslot's action queue and sends menuActionReceived signal to specified workpad.


processMenuClose()

Sends a menuClose signal to the current content View indicating the user has taken an action that should hide the content view's tool menu


processMenuOpen()

Sends a menuOpen signal to the current content View indicating the user has taken an action that should display the content view's tool menu


selectWorkpad( = contentID)

Selects workpad by contentID. Workpad selection is deferred


setMenuGroups()

Sets the currently visible toolbox menu items for the currently visible workspace item


showMenu()

Show the tool menu


zMailbox( = owner)

Returns the ZMailbox object for the specified workpad. Each ZMailbox contains a ZMailslot object for each menu item. Each ZMailslot contains a message queue and a response queue for the menu. Messages are sent to the menu, responses are received from it.