-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A collection of tools which can be used to access taskwarrior from xmonad.
--   
--   TaskMonad is a collection of tools which can be used to access
--   taskwarrior from xmonad.
@package TaskMonad
@version 1.0.0


-- | GridSelect.Extras adds a method to <a>XMonad.Actions.GridSelect</a>
--   that displays a message at the top of the screen while using the
--   normal GridSelect.
module GridSelect.Extras

-- | Select an action and run it in the X monad. Furthermore display a
--   message on top of the screen.
runSelectedActionWithMessageAndIcon :: GSConfig (X ()) -> String -> [[Bool]] -> [(String, X ())] -> X ()

-- | The <a>Default</a> instance gives a basic configuration for
--   <a>gridselect</a>, with the colorizer chosen based on the type.
--   
--   If you want to replace the <a>gs_colorizer</a> field, use
--   <a>buildDefaultGSConfig</a> instead of <a>def</a> to avoid ambiguous
--   type variables.
data GSConfig a
GSConfig :: Integer -> Integer -> Integer -> a -> Bool -> X (String, String) -> String -> TwoD a (Maybe a) -> Rearranger a -> Double -> Double -> String -> GSConfig a
[gs_cellheight] :: GSConfig a -> Integer
[gs_cellwidth] :: GSConfig a -> Integer
[gs_cellpadding] :: GSConfig a -> Integer
[gs_colorizer] :: GSConfig a -> a -> Bool -> X (String, String)
[gs_font] :: GSConfig a -> String
[gs_navigate] :: GSConfig a -> TwoD a (Maybe a)
[gs_rearranger] :: GSConfig a -> Rearranger a
[gs_originFractX] :: GSConfig a -> Double
[gs_originFractY] :: GSConfig a -> Double
[gs_bordercolor] :: GSConfig a -> String

-- | The default value for this type.
def :: Default a => a

-- | Builds a default gs config from a colorizer function.
buildDefaultGSConfig :: (a -> Bool -> X (String, String)) -> GSConfig a

-- | By default gridselect used the defaultNavigation action, which binds
--   left,right,up,down and vi-style h,l,j,k navigation. Return quits
--   gridselect, returning the selected element, while Escape cancels the
--   selection. Slash enters the substring search mode. In substring search
--   mode, every string-associated keystroke is added to a search string,
--   which narrows down the object selection. Substring search mode comes
--   back to regular navigation via Return, while Escape cancels the
--   search. If you want that navigation style, add
--   <a>defaultNavigation</a> as <a>gs_navigate</a> to your <a>GSConfig</a>
--   object. This is done by <a>buildDefaultGSConfig</a> automatically.
defaultNavigation :: TwoD a (Maybe a)
instance Control.Monad.State.Class.MonadState (GridSelect.Extras.TwoDState a) (GridSelect.Extras.TwoD a)
instance GHC.Base.Functor (GridSelect.Extras.TwoD a)
instance GHC.Base.Monad (GridSelect.Extras.TwoD a)
instance GridSelect.Extras.HasColorizer a => Data.Default.Class.Default (GridSelect.Extras.GSConfig a)
instance GHC.Base.Applicative (GridSelect.Extras.TwoD a)
instance GridSelect.Extras.HasColorizer Graphics.X11.Types.Window
instance GridSelect.Extras.HasColorizer GHC.Base.String
instance GridSelect.Extras.HasColorizer a


-- | A wrapper around <a>XMonad.Util.NamedScratchpad</a> that can be used
--   to display taskwarrior commands
module TaskMonad.ScratchPad

-- | Open the TaskWarrior-ScratchPad
taskwarriorScratchpad :: X ()

-- | The TaskWarrior-Scratchpad which contains a tmux session
taskwarriorScratchpads :: [NamedScratchpad]

-- | Modified version of XMonad.Util.NamedScratchpad.hideScratchpadAction
--   which can be used to just show a scratchpad and don't hide it in case
--   it is already shown
hideScratchpadAction :: NamedScratchpads -> String -> X ()

-- | Send a taskwarrior command to the taskwarrior tmux session and open
--   the taskwarrior scratchpad
twscratchpad :: String -> X ()

-- | Send a command to the taskwarrior tmux session
runTmuxCommand :: MonadIO m => String -> m ()


-- | TaskMonad.Utils bundles a number of help functions that can be used to
--   interact with the taskwarrior command line application.
module TaskMonad.Utils

-- | Returns a filtered list of tasks that contains the specified
--   properties of each task
getTaskwarriorTaskList :: String -> [String] -> IO [[String]]

-- | Returns a filtered list of all properties that belong to a given
--   category. For example
--   
--   <pre>
--   getTaskwarriorIds "status:pending" "tags"
--   </pre>
--   
--   returns a list of all tags of the pending tasks. Likewise
--   
--   <pre>
--   getTaskwarriorIds "status:pending" "ids"
--   </pre>
--   
--   returns the ids of all pending tasks.
getTaskwarriorIds :: String -> String -> IO [String]

-- | Checks whether a given taskwarrior command is a report or not
isTWReport :: String -> Bool

-- | A list containing all taskwarrior reports. For further information,
--   please refer to <a>https://taskwarrior.org/docs/report.html</a>
defaulttwreports :: [String]

-- | Executes a shell command.
execCommand :: MonadIO m => String -> m ()

-- | Executes an executable with args and returns the output.
execCommandWithOutput :: FilePath -> String -> IO String

-- | The Taskwarrior icon
twicon :: [[Bool]]


-- | TaskMonad.GridSelect uses <a>Extras</a> to display various information
--   from taskwarrior.
module TaskMonad.GridSelect

-- | A wrapper around <a>taskSelectWithConfig</a> using the default
--   GSConfig
taskSelect :: String -> X ()

-- | A GridSelect displaying a filtered list of all taskwarrior tasks
taskSelectWithConfig :: String -> GSConfig (X ()) -> X ()

-- | A wrapper around <a>tagSelectWithConfig</a> using the default GSConfig
tagSelect :: X ()

-- | A GridSelect displaying a list of the tags of all pending taskwarrior
--   tasks. After a tag has been selected, a second gridselect showing a
--   filtered list of taskwarrior tasks that have the selected tag will be
--   displayed.
tagSelectWithConfig :: (GSConfig (X ()), GSConfig (X ())) -> X ()

-- | A wrapper around <a>projectSelectWithConfig</a> using the default
--   GSConfig
projectSelect :: X ()

-- | A GridSelect displaying a list of all pending projects. After a
--   project has been selected, a second gridselect showing a filtered list
--   of taskwarrior tasks that belong to the selected project will be
--   displayed.
projectSelectWithConfig :: (GSConfig (X ()), GSConfig (X ())) -> X ()

-- | A wrapper around <a>dueSelectWithConfig</a> using the default GSConfig
dueSelect :: X ()

-- | A GridSelect displaying a list of due dates. After a due date has been
--   selected, a second gridselect showing a filtered list of taskwarrior
--   tasks will be displayed.
dueSelectWithConfig :: (GSConfig (X ()), GSConfig (X ())) -> X ()

-- | A wrapper around <a>togglePriorityWithConfig</a> using the default
--   GridSelect.Extras.GSConfig
togglePriority :: String -> X ()

-- | A gridselect showing all pending tasks. The tasks are colored
--   according to their priority. Selecting a task toggles its priority.
togglePriorityWithConfig :: GSConfig (X ()) -> String -> X ()

-- | Method used to build a GridSelect.Extra.GSConfig by specifying a
--   custom cellwidth
buildTWGSExtraConfig :: Integer -> GSConfig (X ())

-- | Method used to build a GSConfig by specifying a custom cellwidth
buildTWGSConfig :: Integer -> GSConfig (X ())

-- | The default GSConfig used for taskwarrior GridSelects
defaultTWGSConfig :: GSConfig (X ())

-- | The default GridSelect.Extra.GSConfig used for taskwarrior GridSelects
defaultTWGSExtraConfig :: GSConfig (X ())


-- | TaskMonad.Prompt provides wrappers around <a>XMonad.Prompt.Input</a>
--   for usage with taskwarrior
module TaskMonad.Prompt

-- | A wrapper around <a>customPrompt</a> that can be used to execute
--   taskwarrior as well as custom commands.
--   
--   You can specify a list of tuples which contain custom actions as well
--   as conditions for the custom actions, like this:
--   
--   <pre>
--   taskwarriorPrompt [(\x -&gt; x == "processInput", processInput)]
--   </pre>
--   
--   However, if none of the specified actions is true, a default action
--   will be executed. The default action shows taskwarrior reports in a
--   scratchpad and executes all the other commands silently.
taskwarriorPrompt :: [(String -> Bool, X ())] -> X ()

-- | A wrapper around <a>XMonad.Prompt.Input</a> using a custom
--   <tt>XPconfig</tt>
customPrompt :: String -> [String] -> (String -> X ()) -> X ()


-- | TaskMonad bundles a number of tools that can be used to directly
--   interact with taskwarrior from within xmonad. Furthermore, workflows
--   following the Getting Things Done principles are implemented.
module TaskMonad

-- | A wrapper around <a>customPrompt</a> that can be used to execute
--   taskwarrior as well as custom commands.
--   
--   You can specify a list of tuples which contain custom actions as well
--   as conditions for the custom actions, like this:
--   
--   <pre>
--   taskwarriorPrompt [(\x -&gt; x == "processInput", processInput)]
--   </pre>
--   
--   However, if none of the specified actions is true, a default action
--   will be executed. The default action shows taskwarrior reports in a
--   scratchpad and executes all the other commands silently.
taskwarriorPrompt :: [(String -> Bool, X ())] -> X ()

-- | Opens a set of gridselects used to process the inbox using the Getting
--   Things Done workflow
processInbox :: X ()

-- | A wrapper around <a>togglePriorityWithConfig</a> using the default
--   GridSelect.Extras.GSConfig
togglePriority :: String -> X ()

-- | A wrapper around <a>taskSelectWithConfig</a> using the default
--   GSConfig
taskSelect :: String -> X ()

-- | A wrapper around <a>dueSelectWithConfig</a> using the default GSConfig
dueSelect :: X ()

-- | A wrapper around <a>tagSelectWithConfig</a> using the default GSConfig
tagSelect :: X ()

-- | A wrapper around <a>projectSelectWithConfig</a> using the default
--   GSConfig
projectSelect :: X ()

-- | The TaskWarrior-Scratchpad which contains a tmux session
taskwarriorScratchpads :: [NamedScratchpad]

-- | Open the TaskWarrior-ScratchPad
taskwarriorScratchpad :: X ()