|
| Graphics.UI.Port.Document | | Portability | portable | | Stability | provisional | | Maintainer | ka2_mail@yahoo.com |
|
|
|
|
| Contents |
- Document templates
- Documents
- Internals
|
|
| Description |
| Documents
|
|
| Synopsis |
|
|
|
|
| Document templates |
|
| data DocumentTemplate a |
| Constructors | | DocumentTemplate | | | dtMimeType :: String | | | dtOrder :: Int | | | dtDescription :: String | | | dtExtensions :: [String] | | | dtNewDocument :: (IO a) | | | dtOpenDocument :: (FilePath -> IO a) | | | dtSaveDocument :: (FilePath -> a -> IO ()) | | | dtPrintDocument :: (a -> IO ()) | | | dtOpenWindow :: (Document a -> IO WindowHandle) | | | dtCompatibleTemplates :: [String] | |
|
|
|
|
| registerDocTemplate :: DocumentTemplate a -> IO () |
| Register new document template |
|
| Documents |
|
| data Document a |
|
|
| readDoc :: Document a -> IO a |
| Read the value of a Document |
|
| writeDoc :: Document a -> a -> IO () |
| Write a new value into a Document. The function automatically turns on the modification flag in the document. |
|
| getDocModified :: Document a -> IO Bool |
| Retrieve the value of the modification flag in the document |
|
| getDocFilePath :: Document a -> IO (Maybe FilePath) |
| Returns the path to the file associated with the document. If there is no such file the returned value is Nothing. |
|
| newDoc :: DocumentTemplate a -> IO (Document a) |
| Create a new document from the specified template |
|
| openDoc :: FilePath -> DocumentTemplate a -> IO (Document a) |
| Open the specified file and create a document associated with it. |
|
| revertDoc :: Document a -> IO () |
| Revert the document |
|
| saveDoc :: FilePath -> Document a -> IO () |
| Save the document to the file specified with its path. The function automatically turns off the modification flag. |
|
| openDocWindow :: Document a -> IO WindowHandle |
| Open new window to display the document. |
|
| printDoc :: Document a -> IO () |
| Print the document |
|
| Internals |
|
| clearDocTemplates :: IO () |
|
| unregisterDocument :: WindowHandle -> IO () |
|
| Produced by Haddock version 0.4 |