The K Desktop Environment

Next Previous Table of Contents

10. Visual Modules Reference

10.1 Gui_PANEL

A panel where you can put other control elements on. You have to specify width and height (these is in 10-pixel-steps, so specifying a panel of width = 10, height = 10 will make a 100*100 pixel object on the screen).

The panel has one output called id, which you can connect to the parent port of other controls to put them into the panel.

10.2 Gui_SUB_PANEL

width,height,pixmap are like panel. But you can put the subpanel into another panel by connecting parent. Then, you can also choose a relative position, (if the parent allows this), by specifying x and y.

10.3 Gui_POTI

This is a turning knob for tuning parameter data. parent,x,y are like in subpanel. color specifies a color (either try names like red or darkgrey, or use #rrggbb notation). caption specifies the title of the knob. min and max are the minimum and maximum parameter values. The knob will start with the position given as initial. Connect value anywhere you like to use the value.

10.4 Gui_SLIDER

Much like the knob. It has two pixmaps for theming (experimental), one is the part that is moving, the other is the background.

10.5 Gui_WINDOW

A window - caption specifies the window title. Put panels or subpanels in there.

10.6 Gui_LABEL

A label - caption specifies the text, parent the parent, x,y the position and pixmap gives a background pixmap. The parameter color specifies the color, while strings like "blue" are allowed as well as #rrggbb color specification.

10.7 Gui_INSTRUMENT_MAPPER

The magic thing for mapping instruments to midi channels with user interaction. Put it in a panel or subpanel and it will be happy.

10.8 Gui_AUDIO_MANAGER

Also a complete control (like instrument mapper). It will display the audio clients that are connected to the audio server (see next section), and allow the user to connect them to busses. It is important to know that without assigning a client a bus, he will not even start playing.

This is about the same concept as window managers who open the window only after letting the user choose a position on the desktop, like found in many window managers.

10.9 Gui_MIXER

This will create a mixer. You'll have to supply following parameters:

parent

Where the mixer should live. You probably should give him a window.

channels

The number of channels you want to have. Note that the mixer operates on stereo channels, so specifying 8 here means actually 16 mono audio channels.

structure

How one channel should look like, see below.

name

The name of the mixer. The individual channels will be named <name>01, <name>02, <name>03,...

output

What the output bus is to be used.

The structure that you give the mixer should contain one (stereo) mixer channel, with a control panel. It should have the following parameters:

input (IN string property)

Which is the bus where this individual channel should get its data from. You'll have to get the data yourself with a Synth_BUS_DOWNLINK.

parent (IN audio signal)

A parent specification where your control panel should be drawn. But a Gui_SUB_PANEL widget there.

output (IN string property)

Which is the bus where this individual channel should send its data to. You'll have to send the data yourself with a Synth_BUS_UPLINK.

Next Previous Table of Contents