| Copyright | (C) 2008 Luis Cabellos |
|---|---|
| License | BSD3 |
| Maintainer | zhen.sydow@gmail.com |
| Stability | unstable |
| Portability | unportable |
| Safe Haskell | None |
| Language | Haskell98 |
XMonad.Prompt.AppLauncher
Description
A module for launch applicationes that receive parameters in the command line. The launcher call a prompt to get the parameters.
Synopsis
- launchApp :: XPConfig -> Application -> X ()
- class XPrompt t where
- showXPrompt :: t -> String
- data XPConfig
- mkXPrompt :: XPrompt p => p -> XPConfig -> ComplFunction -> (String -> X ()) -> X ()
- type Application = String
- data AppPrompt
Usage
This module is intended to allow the launch of the same application but changing the parameters using the user response. For example, when you want to open a image in gimp program, you can open gimp and then use the File Menu to open the image or you can use this module to select the image in the command line.
We use Prompt to get the user command line. This also allow to autoexpand the names of the files when we are writing the command line.
launchApp :: XPConfig -> Application -> X () Source #
Get the user's response to a prompt an launch an application using the input as command parameters of the application.
class XPrompt t where Source #
A class for an abstract prompt. In order for your data type to be a valid prompt you _must_ make it an instance of this class.
The minimal complete definition is just showXPrompt, i.e. the name
of the prompt. This string will be displayed in the command line
window (before the cursor).
As an example of a complete XPrompt instance definition, we can
look at the Shell prompt from
XMonad.Prompt.Shell:
data Shell = Shell
instance XPrompt Shell where
showXPrompt Shell = "Run: "Methods
showXPrompt :: t -> String Source #
This method is used to print the string to be displayed in the command line window.
Instances
mkXPrompt :: XPrompt p => p -> XPConfig -> ComplFunction -> (String -> X ()) -> X () Source #
Creates a prompt given:
- a prompt type, instance of the
XPromptclass. - a prompt configuration (
defcan be used as a starting point) - a completion function (
mkComplFunFromListcan be used to create a completions function given a list of possible completions) - an action to be run: the action must take a string and return
X()
Use case: launching gimp with file
First, you need to import necessary modules. Prompt is used to get the promp configuration and the AppLauncher module itself.
import XMonad.Prompt import XMonad.Prompt.AppLauncher as AL
Then you can add the bindings to the applications.
... , ((modm, xK_g), AL.launchApp def "gimp" ) , ((modm, xK_g), AL.launchApp def "evince" ) ...
Types
type Application = String Source #
Instances
| XPrompt AppPrompt Source # | |
Defined in XMonad.Prompt.AppLauncher Methods showXPrompt :: AppPrompt -> String Source # nextCompletion :: AppPrompt -> String -> [String] -> String Source # commandToComplete :: AppPrompt -> String -> String Source # completionToCommand :: AppPrompt -> String -> String Source # completionFunction :: AppPrompt -> ComplFunction Source # modeAction :: AppPrompt -> String -> String -> X () Source # | |