lnview.hpp

IBM Lotus C++ API 7.0a for IBM Lotus Notes/Domino Directory Release --------- ------------------

		{ return Goto(LNNAVIGATION_PREV_PARENT, entry); }
	LNSTATUS GotoPreviousSibling( LNVFEntry *entry = 0 ) const
		{ return Goto(LNNAVIGATION_PREV_SIBLING, entry); }
	LNSTATUS GotoPreviousUnread( LNVFEntry *entry = 0 ) const
		{ return Goto(LNNAVIGATION_PREV_UNREAD, entry); }
	LNSTATUS GotoPreviousUnreadMain( LNVFEntry *entry = 0 ) const
		{ return Goto(LNNAVIGATION_PREV_UNREAD_MAIN, entry); }
	
	LNBOOL IsCategorized() const;
	
	LNSTATUS Refresh() const;
	
	LNSTATUS ResetPosition() const;

	LNSTATUS SetCacheSize(LNINT cacheSize);


	// Common design functions (used by all design notes):

	
	LNString GetAlias() const;
	LNSTATUS SetAlias( const LNString &alias );

	LNBOOL GetAllowDesignRefreshToModify() const;
	void SetAllowDesignRefreshToModify( LNBOOL flag );

	LNString GetComment() const;
	LNSTATUS SetComment( const LNString &comment );

	LNBOOL GetHideFromBrowsers() const;
	void SetHideFromBrowsers( LNBOOL flag );

	LNBOOL GetHideFromClients() const;
	void SetHideFromClients( LNBOOL flag );

	LNBOOL GetHideFromR4Clients() const;
	void SetHideFromR4Clients( LNBOOL flag );

	LNString GetInheritsFromTemplateName() const;
	LNSTATUS SetInheritsFromTemplateName( const LNString &name );

	LNString GetName() const;
	LNSTATUS SetName( const LNString &name );

	LNBOOL GetPropagateAllowDesignChange () const;
    void SetPropagateAllowDesignChange (LNBOOL propagate);

	// View/folder design functions:

	LNSTATUS AppendColumn( LNVFColumn *newcol = 0 );
	LNSTATUS AppendColumn( const LNVFColumn &oldcol, LNVFColumn *newcol = 0 );

	LNSTATUS AppendColumns( LNINT count );

	LNSTATUS DeleteColumn( LNINT n );
	LNSTATUS DeleteColumn( LNVFColumn *column );

	LNSTATUS DeleteColumns( LNINT n, LNINT count  );

	LNSTATUS GetActions( LNActions *pactions ) const;
	LNSTATUS SetActions( const LNActions &actions );

	LNColor GetActiveLinkColor() const;
	LNSTATUS SetActiveLinkColor( const LNColor &color );

	LNBOOL GetAllowAllAuthors() const;
	void SetAllowAllAuthors( LNBOOL flag );

	LNBOOL GetAllowToOverrideTimes() const;
	void SetAllowToOverrideTimes(LNBOOL flag);

	LNBOOL GetAllowAllReaders() const;
	void SetAllowAllReaders( LNBOOL flag );

	LNBOOL GetAllowPublicAccessUsers() const;
	void SetAllowPublicAccessUsers( LNBOOL flag );

	LNColor GetAlternateRowColor() const;
	LNSTATUS SetAlternateRowColor( const LNColor &color );

	LNText GetAuthors() const;
	LNSTATUS SetAuthors( const LNText &names );

	LNColor GetBackgroundColor() const;
	LNSTATUS SetBackgroundColor( const LNColor &color );

	LNFontStyle GetBorderFontStyle() const;
	LNSTATUS SetBorderFontStyle( const LNFontStyle &style );

	LNColor GetBusyRowColor() const;
	LNSTATUS SetBusyRowColor( const LNColor &color );

	LNVFCALENDARFORMATS GetCalendarFormats() const;
	LNSTATUS SetCalendarFormats(LNVFCALENDARFORMATS flags = LNVFCALENDARFORMATS_FORMAT_ALL);

	LNFontStyle GetCalendarHeaderFontStyle() const;
	LNSTATUS SetCalendarHeaderFontStyle( const LNFontStyle &style );

	LNVFCALENDARINITIALFORMAT GetCalendarInitialFormat() const;
	LNSTATUS SetCalendarInitialFormat(LNVFCALENDARINITIALFORMAT format = LNVFCALENDARINITIALFORMAT_LAST_VIEWED);

	LNBOOL GetCollapseOnOpen() const;
	void SetCollapseOnOpen( LNBOOL flag );

	LNSTATUS GetColumn( LNINT n, LNVFColumn *column ) const;
	LNSTATUS GetColumn( const LNString &title, LNVFColumn *column ) const;

	LNINT GetColumnCount() const;

	LNFontStyle GetDateFontStyle() const;
	LNSTATUS SetDateFontStyle( const LNFontStyle &style );

	LNColor GetDateBackgroundColor() const;
	LNSTATUS SetDateBackgroundColor(const LNColor &color);

	LNColor GetDaySeparatorColor() const;
	LNSTATUS SetDaySeparatorColor( const LNColor &color );

	LNBOOL GetEnableTimeGrouping() const;
	void SetEnableTimeGrouping(LNBOOL flag);

	LNBOOL GetExtendLastColumn() const;
	void SetExtendLastColumn( LNBOOL flag );

    LNSTATUS GetEventFormula(LNFORMULAEVENT event, LNFormula *formula ) const;
    LNSTATUS SetEventFormula( const LNFormula &formula, LNFORMULAEVENT event );

	LNSTATUS GetFormFormula( LNFormula *formula ) const;
	LNSTATUS SetFormFormula( const LNFormula &formula );

	LNBOOL GetGenerateUniqueKeys() const;
	void SetGenerateUniqueKeys( LNBOOL flag );

    LNSTATUS GetGlobalLotusScript (LNLotusScript * pScript) const;
	LNSTATUS SetGlobalLotusScript(const LNLotusScript &script);

	LNVFHEADINGDISPLAY GetHeadingDisplay() const;
	LNSTATUS SetHeadingDisplay( LNVFHEADINGDISPLAY option );
/*
	LNSTATUS GetHelpRequestFormula( LNFormula *formula );
	LNSTATUS SetHelpRequestFormula( const LNFormula &formula );
*/

	LNBOOL GetIsDefaultDesign() const;
	void SetIsDefaultDesign( LNBOOL flag );

	LNBOOL GetIsDefaultViewFolder() const;
	void SetIsDefaultViewFolder( LNBOOL flag );

	LNINT GetLinesPerHeading() const;
	LNSTATUS SetLinesPerHeading( LNINT count );

	LNINT GetLinesPerRow() const;
	LNSTATUS SetLinesPerRow( LNINT count );

    LNSTATUS GetLotusScript (LNLotusScript * pScript) const;
	LNSTATUS SetLotusScript(const LNLotusScript &script);

	LNColor GetNonMonthBackgroundColor() const;
	LNSTATUS SetNonMonthBackgroundColor(const LNColor &color);

	LNColor GetNonMonthTextColor() const;
	LNSTATUS SetNonMonthTextColor(const LNColor &color);

	LNVFOPENPOSITION GetOpenPosition() const;
	LNSTATUS SetOpenPosition( LNVFOPENPOSITION position );

	LNText GetReaders() const;
	LNSTATUS SetReaders( const LNText &names );

	LNVFREFRESHOPTION GetRefreshOption() const;
	LNSTATUS SetRefreshOption( LNVFREFRESHOPTION option );

	LNVFROWSPACING GetRowSpacing();
	LNSTATUS SetRowSpacing( LNVFROWSPACING spacing );

	LNSTATUS GetSelectionFormula( LNFormula *formula ) const;
	LNSTATUS SetSelectionFormula( const LNFormula &formula );

	LNVFSHARINGOPTION GetSharingOption() const;

	LNBOOL GetShowCalendarConflicts() const;
	void SetShowCalendarConflicts( LNBOOL flag );

	LNBOOL GetShowInViewMenu() const;
	void SetShowInViewMenu( LNBOOL flag );

	LNBOOL GetShowReplicationConflicts() const;
	void SetShowReplicationConflicts( LNBOOL flag );

	LNBOOL GetShowResponseHierarchy() const;
	void SetShowResponseHierarchy( LNBOOL flag );

	LNBOOL GetShowSelectionMargin() const;
	void SetShowSelectionMargin( LNBOOL flag );

	LNBOOL GetShrinkRows() const;
	void SetShrinkRows( LNBOOL flag );

	LNVFSTYLE GetStyle() const;
	LNSTATUS SetStyle( LNVFSTYLE style );

	LNVFTIMESLOTDISPLAY GetTimeSlotDisplay() const;
	LNSTATUS SetTimeSlotDisplay( LNVFTIMESLOTDISPLAY option );

	LNVFTIMESLOTDURATION GetTimeSlotDuration() const;
	LNSTATUS SetTimeSlotDuration( LNVFTIMESLOTDURATION duration );

	LNINT GetTimeSlotEndHour() const;
	LNSTATUS SetTimeSlotEndHour( LNINT hour );

	LNFontStyle GetTimeSlotFontStyle() const;
	LNSTATUS SetTimeSlotFontStyle( const LNFontStyle &style );

	LNINT GetTimeSlotStartHour() const;
	LNSTATUS SetTimeSlotStartHour( LNINT hour );

	LNColor GetTodayColor() const;
	LNSTATUS SetTodayColor( const LNColor &color );

	LNFontStyle GetTotalsFontStyle() const;
	LNSTATUS SetTotalsFontStyle( const LNFontStyle &style );

	LNBOOL GetTreatContentsAsHTML() const;
	void SetTreatContentsAsHTML( LNBOOL flag );

	LNVFTYPE GetType();

	LNFontStyle GetUnreadFontStyle() const;
	LNSTATUS SetUnreadFontStyle( const LNFontStyle &style );

	LNVFUNREADMARKDISPLAY GetUnreadMarkDisplay() const;
	LNSTATUS SetUnreadMarkDisplay( LNVFUNREADMARKDISPLAY option );

	LNColor GetUnvisitedLinkColor() const;
	LNSTATUS SetUnvisitedLinkColor( const LNColor &color );

	LNBOOL GetUseAlternateRowColor() const;
	void SetUseAlternateRowColor( LNBOOL flag );

	LNBOOL GetUseAppletInBrowser() const;
	void SetUseAppletInBrowser( LNBOOL flag );

	LNINT GetVersion() const;

	LNColor GetVisitedLinkColor() const;
	LNSTATUS SetVisitedLinkColor( const LNColor &color );

	LNSTATUS InsertColumn( LNINT n, LNVFColumn *newcol = 0 );
	LNSTATUS InsertColumn
		( LNINT n, const LNVFColumn &oldcol, LNVFColumn *newcol = 0 );

	LNSTATUS InsertColumns( LNINT n, LNINT count );

	LNBOOL IsCalendar() const;

	LNBOOL IsFolder();
	
	LNBOOL IsPrivate() const;

	LNBOOL IsView();	


private:
	LNViewFolder( LNDatabaseBody *db, NOTEID id );
	
	LNViewFolder & operator=( LNViewFolderBody *viewfolder );
	
	LNSTATUS CreateViewFolderBody();
	
	LNSTATUS GetIDTable( HANDLE *idtable ) const;
	
	LNViewFolderBody * GetViewFolderBody() const
		{ return (LNViewFolderBody *) Body; }
	
	LNSTATUS Goto( LNNAVIGATION where, LNVFEntry *entry ) const;
	
	virtual void ValidateNoteType( const LNNote &note ) const;
	virtual void ValidateNoteType( const LNNoteBody *note ) const;
	virtual void ValidateNoteType( LNNOTETYPE type ) const;
};

//---------------------------------------------------------------------------
// 	Class name:	LNVFColumn
//
//	Description:
//	
//	LNVFColumn provides access to column-specific view and folder design
//	attributes. LNVFColumn is a "smart pointer" for LNVFColumnBody, which
//	contains the actual implementation.
//---------------------------------------------------------------------------

class LNIMPEXPCL LNVFColumn : public LNSmartPtr
{

public:
	LNVFColumn() {}
	LNVFColumn( const LNVFColumn &column ) : LNSmartPtr(column) {}

	~LNVFColumn() {}

	LNVFColumn & operator=( const LNVFColumn &column )
		{ LNSmartPtr::operator=(column); return *this; }

	LNBOOL GetCategorizedIsFlatInR5() const;
	void SetCategorizedIsFlatInR5(LNBOOL flag);

	LNCLASSID GetClassID() const { return LNCLASSID_LNVFCOLUMN; }

	LNINT GetColumnNumber() const;

	LNDatetimeFormat GetDatetimeFormat() const;
	LNSTATUS SetDatetimeFormat( const LNDatetimeFormat &format );

	LNBOOL GetDisplayValuesAsIcons() const;
	void SetDisplayValuesAsIcons( LNBOOL flag );

	LNINT GetExactWidth() const;
	LNSTATUS SetExactWidth( LNINT width );

	LNString GetFieldName() const;
	LNSTATUS SetFieldName( const LNString &name );

	LNFontStyle GetFontStyle() const;
	LNSTATUS SetFontStyle( const LNFontStyle &style );

	LNSTATUS GetFormula( LNFormula *formula ) const;
	LNSTATUS SetFormula( const LNFormula &formula );

	LNVFHEADINGSORTOPTION GetHeadingSortOption() const;
	LNSTATUS SetHeadingSortOption( LNVFHEADINGSORTOPTION option );

	LNSTATUS GetHeadingSortViewFolder( LNViewFolder *viewfolder ) const;
	LNSTATUS SetHeadingSortViewFolder( const LNViewFolder &viewfolder );

	LNBOOL GetHideColumn() const;
	void SetHideColumn( LNBOOL flag );

	LNBOOL GetHideDetailRows() const;
	void SetHideDetailRows( LNBOOL flag );

	LNString GetInternalName() const;
	LNSTATUS SetInternalName( const LNString &name );

	LNBOOL GetIsCategorized() const;
	void SetIsCategorized( LNBOOL flag );

	LNBOOL GetIsResizable() const;
	void SetIsResizable( LNBOOL flag );

	LNVFJUSTIFICATION GetJustification() const;
	LNSTATUS SetJustification( LNVFJUSTIFICATION option );

	LNNumberFormat GetNumberFormat() const;
	LNSTATUS SetNumberFormat( const LNNumberFormat &format );

	LNINT GetSecondarySortColumn() const;
	LNSTATUS SetSecondarySortColumn( LNINT n );
	LNSTATUS SetSecondarySortColumn( const LNString &title );

	LNVFSORTOPTION GetSecondarySortOption() const;
	LNSTATUS SetSecondarySortOption( LNVFSORTOPTION option );

	LNBOOL GetSeparateMultipleValues() const;
	void SetSeparateMultipleValues( LNBOOL flag );

	LNVFSEPARATOR GetSeparator() const;
	LNSTATUS SetSeparator( LNVFSEPARATOR separator );

	LNBOOL GetShowResponsesOnly() const;
	void SetShowResponsesOnly( LNBOOL flag );

	LNBOOL GetShowTwistie() const;
	void SetShowTwistie( LNBOOL flag );

	LNBOOL GetShowValuesAsLinks() const;
	void SetShowValuesAsLinks( LNBOOL flag );

	LNVFSORTOPTION GetSortOption() const;
	LNSTATUS SetSortOption( LNVFSORTOPTION option );

	LNString GetTitle() const;
	LNSTATUS SetTitle( const LNString &title );

	LNFontStyle GetTitleFontStyle() const;
	LNSTATUS SetTitleFontStyle( const LNFontStyle &style );

	LNVFJUSTIFICATION GetTitleJustification() const;
	LNSTATUS SetTitleJustification( LNVFJUSTIFICATION option );

	LNVFTOTALSOPTION GetTotalsOption() const;
	LNSTATUS SetTotalsOption( LNVFTOTALSOPTION option );

	LNBOOL GetUseAccentSensitiveSort() const;
	void SetUseAccentSensitiveSort( LNBOOL flag );

	LNBOOL GetUseCaseSensitiveSort() const;
	void SetUseCaseSensitiveSort( LNBOOL flag );

	LNSTATUS GetViewFolder( LNViewFolder *viewfolder ) const;
	
	LNINT GetWidthInCharacters() const;
	LNSTATUS SetWidthInCharacters( LNINT width );

private:
	LNVFColumn & operator=( LNVFColumnBody *column )
		{ return (LNVFColumn &) LNSmartPtr::operator=((LNBody *) column); }

	LNVFColumnBody * GetVFColumnBody() const
		{ return (LNVFColumnBody *) Body; }
};

//---------------------------------------------------------------------------
// 	Class name:	LNVFEntry
//
//	Description:
//	
//	LNVFEntry represents an entry (row) in a database view or folder, and
//	provides access to both the corresponding document and the data items
//	displayed in the view or folder columns.
//---------------------------------------------------------------------------

class LNIMPEXPCL LNVFEntry : public LNSmartPtr
{

public:
	LNVFEntry() {}
	LNVFEntry( const LNVFEntry &entry ) : LNSmartPtr(entry) {}
	
	~LNVFEntry() {}
	
	LNVFEntry & operator=( const LNVFEntry &entry )
		{ return (LNVFEntry &) LNSmartPtr::operator=(entry); }