next up previous contents
Next: 6 Questions and answers Up: The KGoodStuff Handbook Previous: 4 Runtime options   Contents

Subsections

5 The Menu Entries

5.1 Help

Opens this help-text.

5.2 About

Shows a short information window.

5.3 New

Creates a New Button before the button you selected this option on.

5.4 Copy

Copy the actual Button to the local Clipboard.

5.5 Paste

Creates a New Button (as New), and sets all its value from the local clipboard.

5.6 Cut

Cut's the actual button from the Button-Bar, to the local Clipboard.

5.7 Button Options

This function opens a Dialog-Window in which you can set the values for the actual button. This values are:

5.7.1 Desktop

You can specify here a .desktop or a .kdelnk file (with full path) or just drop one on this input

field and the name is put there automatically. After that most of the input fields are readonly as the values of the Desktop-File are used.

5.7.2 Name:

Set the Name of the Button, which appears under the icon in the Button-Box. You may also let this value empty in which case no Label appears. You may insert ``\n'' into the string and so force to have a multi line label.

5.7.3 Command:

The command to execute when the button is pressed. You can also drop an executable on the input field and it is filled automatically. There are this special strings you can insert in the command:

%f
Insert a %f if you would like to drop documents onto this button. The %f is substitued by the path to the document.
%s
This has 2 different syntaxes and they are strikt so if you want to use this feature read the following with active mind :)

  1. %s:i:<label name>[:<default input>[:<group name]]:%

    This opens a dialog with an input-field and what you enter there is substitued by the whole option in the final executed command (i = input).

    <label name>
    This is the name of the label wich gives this input field a name
    <default input>
    This is put into the input field and is the default if not changed this can be ommitted so that you don't have any default.
    <group name>
    If you define this then a frame box is created with the specified name as label and the input is put into the frame.
  2. %s:c:<label name>[:<option string>[:(true|false)[:<group name>]]]:%

    This adds to the options dialog of this command a checkbox. If this checkbox is checked the the whole option string is substitued by <option string> otherwise by an empty string (c = checkbox).

    <label name>
    This gives the checkbox a name (set the label)
    <option string>
    Is the option by with when checked the string should be substitued
    (true | false)
    The checkbox is default checked or not (default is false)
    <group name>
    If you define this then a frame box is created with the specified name as label and the input is put into the frame.
  3. %s:r:<label name>[:<option string>[:(true|false)[:<group name>]]]:%

    This adds to the options dialog of this command a ButtonGroup and inserts a radio button inside it. If the radio button is checked the the whole option string is substitued by <option string> otherwise by an empty string (r = radiobutton).

    <label name>
    This gives the checkbox a name (set the label)
    <option string>
    Is the option by with when checked the string should be substitued
    (true | false)
    The checkbox is default checked or not (default is false)
    <button group name>
    If you define this then a frame box is created with the specified name as label and the input is put into the frame. This is needed if you want more than one group of radio buttons.
  4. %s:t:<title name>:%

    With this put in any place inside the command you may specify the title of the parameters dialog opened with this commands.

IMPORTANT:
Pay attention that you have to start and end the command with the % sign!!!
If you need to put ':' chars inside the %s-syntax strings you can do this by escaping them with \ as to put them like '\:' instead of ':', as that is the field delimitator.

The same is valid for % chars which can be escaped also with a \ (backslash). This may be useful if you want to put %f into the command which should not be substituted by the droped filenames. In that case you can put there \%f.

Example:
tail -n%s:c:From the start:+:true:% %s:i:lines:10:% %f opens an option box with the checkbox From the start checked by default and the input field lines with 10 as default input. So if we drop a file on this button and just hit enter with this defaults in the opening options box, the command tail -n +10 <name of droped file> is executed, if you would uncheck the checkbox then the command tail -n 10 <name of droped file> is executed.

5.7.4 D&D Command:

With this you can specify a distinct command for Drag&Drop action or normal MouseClick. For special parameters see the Command description. You can also drop an executable on the input field and it is filled automatically.

5.7.5 Description:

This is an optional text which appears as a Tool-Tip.

5.7.6 Icon (click on the Icon-Button):

This is an Icon-Selector, in which you can select which Icon you want to show in the Button-Bar for the actual button.

5.7.7 Don't show the Name as button Label

As said this is a checkbox to not show the Name of this button as a Label under the icon on screen. This is particulary usefull for child-Buttons as there the name is obligatory, but someone could decide that he doesn't like it to appear as a label on the button.

5.7.8 Don't show the Icon

As the label says this checkbox does hide the icon. Doing this the label text is centered. This is usefull if you have multiline labels and don't need the icon so that the icon size is not enlarged. BTW.: if you don't specify an icon it does the same only that the button label is on the bottom, not centered.

5.7.9 Window Title:

This is equal to the "Window Title" entry for .kdelnk-files, so a window with this title is swallowed by this button.

5.7.10 Swallow Command:

This is equal to the "Execute"-swallow option for .kdelnk-files. You can also drop an executable on the input field and it is filled automatically. This command is executed for the swallowing of this button. Pay attention that you catch this application by the "Swallow Name"!!!

5.7.11 Check if Swallow Process exited

This is on by default and should check if the process we swallowed in the Button exited, because of (most probaly) some faulty behaviour. This checkbox is there for applications which detach themself of the controlling terminal and do not have any runtime option to disable this behaviour f.ex. KPager. For this type of applications this checkbox should be disabled as KGoodStuff thinks that the program terminated if controll get's back to it, which obviously is not true.

5.7.12 Use Rows:

How much rows should the button display/extend on.

IMPORTANT: If you display the KGoodStuff horizontally so the display is automatically trimmed to the Rows entry in the global setup!!!

5.7.13 Use Columns:

How much columns should the button display/extend on.

IMPORTANT: If you display KGoodStuff vertically so the display is automatically trimmed to the Columns entry in the global setup!!!

5.7.14 Child Buttonbar:

If you press this button, the button becomes an On/Off button for a child buttonbar with the name defined in the Name-field. This creates and opens a new buttonbar which you then can configure like the original one!

5.7.15 Close Child after first click:

If you check this button the child-buttonbar is closed automatically after the first click on it. This is usefull if you have a child-buttonbar with f.ex. applications and after selecting the application you want run the child is closed automatically.

5.8 Global Options

This function opens a Dialog-Window in which you may set the global options of the Button-Bar. This values are:

5.8.1 MaxXY:

The maximal width of a button in pixels. The icons larger then the new width are scaled so that they fit in. The text is not scaled and so if you select a too small width the text is not displayed correctly (default: empty).

5.8.2 MinXY:

The minimal width of a button in pixels.

5.8.3 Horizontal Orientation:

Here you can define if your button bar should be horizontal or vertical aligned (default: vertical).

5.8.4 PosX:

The X-Position where to put the button-bar on startup (default: empty). Active only if this is a "floating" button-bar.

5.8.5 PosY:

The Y-Position where to put the button-bar on startup (default: empty). \\\> Active only if this is a "floating" button-bar.

5.8.6 Columns(Rows):

The number or Columns (if vertical aligned) or Rows (if horizontal aligned) to use when displaying the buttons (default: 1).

5.8.7 Allow resizing of Icon to actual button size

If this is checked on the icon of the button is enlarged to the actual button size, if (obviously) this button has a size greater then the size of the icon.

5.8.8 Raise delay:

This are in milliseconds the delay that makes KGoodStuff raise automatically above all other windows on the display, so that it is fully visible. If the value is 0 then the function is disabled. Active only if this buttonbar is NOT "Auto Hiding" and NOT "Stay on top".

5.8.9 Lower delay:

This are in milliseconds the delay that makes KGoodStuff lower automatically under all other windows on the display, so that it does not hide any other windowpart. If the value is 0 then the function is disabled. Active only if this buttonbar is NOT "Auto Hiding" and NOT "Stay on top". IMPORTANT: Any child-buttonbar is seen as "other" so leaving one buttonbar for a child/master button-bar this function is also called!!!

5.8.10 Font selection

Select the global font you want text to appear in the button.

5.8.11 Position:

This are 5 checkboxes which mean position the button-bar:

When the Position is Floating (the button in the center of the field) then the values of the X-Pos

and Y-Pos fields are telling the position on screen.

5.8.12 Auto Hide:

This is only activated if the position is NOT floating or if it is floating then depending on the orientation the PosX/PosY input fields have to be [-]0. This means to be able to Auto Hide you have to put the Button-Bar on a border-position!

5.8.13 Stay on top

This (as the options tells) will put the Button-Bar always on top of all other windows. This is especialy usefull if Auto Hide is activated so when the Button-Bar is hidden you can not cover it with another window and so not recall it with the mouse.

5.8.14 Delay

This option is only active if Auto Hide is checked. It tells the delay to wait before hiding the Button-Bar, when there is no mouse-cursor on it.

5.8.15 Speed

The speed of the movement for (un)hiding the Button-Bar.

5.9 Save Options

As it says this saves your actual options, the global ones and for all buttons This is important as if you move buttons around or move the button-bar to another location it is NOT saved automatically!!!

5.10 Quit

Exits the program.


next up previous contents
Next: 6 Questions and answers Up: The KGoodStuff Handbook Previous: 4 Runtime options   Contents


Jürgen Vigna[December 28 2001]