AppigoNote Class Reference

A class for representing an importable note. More...

Public Member Functions

(id) - initWithName:
(NSString *) - plainTextRepresentationWithName:
(AppigoTask *) - taskRepresentation

Properties

NSString * name
NSString * text
NSString * notebook

Detailed Description

A class for representing an importable note.

A class to represent a note that can be placed on the Appigo Pasteboard and referenced by Appigo Applications.


Member Function Documentation

- (id) initWithName: (NSString *)  noteName  

Initialize a new note object.

Parameters:
noteName The note name. The name will be trimmed of whitespace (an empty name is invalid and will be replaced with, "Unknown").
- (NSString *) plainTextRepresentationWithName: (BOOL)  includeName  

Get a plain text representation of a note.

Parameters:
includeName Specify YES to include the name in the text representation or NO to omit it.
Returns:
Returns a plain text representation of the note.
- (AppigoTask *) taskRepresentation  

Build an AppigoTask object from the note that can be used to import the note into Appigo Todo.

Returns:
Returns an AppigoTask object.

Property Documentation

- (NSString *) name [read, assign]

The name/title of the note.

- (NSString *) notebook [read, write, retain]

A case-insensitive notebook name that the note belongs to. If a matching notebook is found in Notebook, the note will be placed inside the corresponding notebook when imported. If multiple notebooks with the same name exist in Notebook, the notebook used for this note is undefined. If a matching notebook name is not found during import, the notebook will be created before assigning the note to the notebook.

- (NSString *) text [read, write, retain]

The note's text which does not include the name.


The documentation for this class was generated from the following file:
Copyright © 2009-2010 Appigo, Inc. All rights reserved.