kr_group.h

这是法国Kaleido公司提供了一个手机mmi设计平台

	<p>When the user "accepts" an option (triggering an accept action), this option is kept at the group Level. This field is kept in the group object.</p>
	<p>In the C version, the ownership of the returned object is not transferred to the caller.</p>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	Option* getOptionAccepted() {
		return fOptionAccepted;
	}

	void setOptionAccepted(Option* o) {
		fOptionAccepted = o;
	}
	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>getActivatingOption</method>
	<java>Option getActivatingOption()</java>
	<cpp>Option* getActivatingOption()</cpp>
	<descr>
	<p>Returns the Option that has activated this group (through a binding on focus or a binding on accept).</p>
	<p>In the C version, the ownership of the returned object is not transferred to the caller.</p>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	Option* getActivatingOption() {
		return fActivatingOption;
	}


	void setActivatingOption(Option* o) {
		fActivatingOption = o;
	}

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>outdateOptions</method>
	<cpp>void outdateOptions()</cpp>
	<java></java>
	<descr>
	<p>This method marks all options in the cache has "outdated". No options are deleted. When a option is needed and found outdated, the populator is called to refresh it.</p>
	<p>The following method is called:</p>
	<code>Option* getOption(long index, Option* oldoption)</code>
	<p>The oldoption parameter contains the option to refresh. If needed, the populator has to update members of the option and return it.</p>
	<p>This method also</p>
	</descr>
	<notes></notes>
	<examples></examples>
	</api>
</page>
</kaleidoc>
	*/
	void outdateOptions(boolean setrefresh = true);

#ifdef USE_DEPRECATED
	void removeOptions();//deprecated
#endif

#ifdef USE_DEPRECATED
	void resetOptions();
#endif
	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>deleteOptions</method>
	<cpp>void deleteOptions()</cpp>
	<java>final public void deleteOptions()</java>
	<descr>
	<p>Deletes the options in the Group's cache. If a populator is associated, needed options will be generated again.
	This call resets the focus. This calls clears the accept history stack.</p>
	<p> This does not delete the template cache which can still be used to generate options with Group.makeOptionFromTemplate().
	To delete the template cache, Group.deleteTemplateOptions() should be used.</p>
	</descr>
	<notes></notes>
	<examples></examples>
	</api>
</page>
</kaleidoc>
	*/
	void deleteOptions(boolean losefocus=true);
	void deleteNotCachedOptions();
	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>deleteTemplateOptions</method>
	<cpp>void deleteTemplateOptions()</cpp>
	<java>void deleteTemplateOptions()</java>
	<descr>
	<p>Deletes all templates options (but not the templates array itself).</p>
	</descr>
	<notes></notes>
	<examples></examples>
	</api>
</page>
</kaleidoc>
	*/
	void deleteTemplateOptions();

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>getOptionInCache</method>
	<java>Option getOptionInCache(int index)</java>
	<cpp>Option* getOptionInCache(long index)</cpp>
	<descr>
	<p>Returns the option at index if it is in the options cache kept at Group level. This does NOT ask the populator to build a missing option and return null instead. </p>
	<p>In the C version, the ownership of options returned by Group.getOptionInCache() is kept by the Group.</p>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	Option* getOptionInCache(long index);

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>getOption</method>
	<java>Option getOption(long index)</java>
	<cpp>Option* getOption(long index)</cpp>
	<descr>
	<p>Returns the option at index in the group cache. if the option is missing in the cache, it is requested to the populator if any.</p>
	<p>getOption() may return null. For example, if a populator returns 5 in getNbOptions() (available options at index 0 to 4), null is returned for getOption(5).</p>
	<p>In the C version, the ownership of options returned by Group.getOptionInCache() is kept by the Group.</p>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	Option* getOption(long index);

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>getNbOptionInCache</method>
	<java>int getNbOptionInCache()</java>
	<cpp>long getNbOptionInCache()</cpp>
	<descr>
	<p>Returns the number of Options in the Group cache.</p>
	<xref>nbOptionInGroup</xref>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	long getNbOptionInCache();

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>getNbOption</method>
	<java>int getNbOption()</java>
	<cpp>long getNbOption()</cpp>
	<descr>
	<p>Returns the number of Options in the Group ie the max of the sizes of the cache and populator.</p>
	<xref>nbOptionInGroup</xref>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	long getNbOption() ;	

#ifdef USE_DEPRECATED
	boolean isActivatedOnFocus() { //deprecated
		return isActivated();
	}
#endif
	boolean isInitialGroup();
	boolean isActivated() ;

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>deleteLazyOptions</method>
	<cpp>void deleteLazyOptions()</cpp>
	<java></java>
	<descr>
	<p>Group.deleteLazyOptions() deletes only options that comes from a populator and are not in the accept History.
	Group.resetFocusIndex() is called.
	KPage.deleteLazyOptions() calls Group.deleteLazyOptions() for all groups.</p>
	</descr>
	<notes></notes>
	<examples></examples>
	</api>
</page>
</kaleidoc>
	*/
	void deleteLazyOptions();

	void setActivateStamp() ;

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>getFocusOption</method>
	<java>Option getFocusOption()</java>
	<cpp>Option* getFocusOption()</cpp>
	<descr>
	<p>Returns the Option that has the focus index. Use getFocusIndex() to get only the index.</p>
	<p>In the C version, the ownership of the returned object is not transferred to the caller.</p>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	Option* getFocusOption();	

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>doStep</method>
	<java>void doStep(long step)</java>
	<cpp>void doStep(long step)</cpp>
	<descr>
	<p>Moves the focus in the Option list. step can have a negative value. Next option is reached with a step 1. The previous one with a step -1.</p>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	void doStep(long step) ;

	void setRotate(boolean b) {
		fRotate = b;
	}

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>isRotate</method>
	<java>boolean isRotate()</java>
	<cpp>boolean isRotate()</cpp>
	<descr>
	<p>Returns true if the focus of the Group is in rolling mode. The rolling mode is normally set in Kaleido Design.</p>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	boolean isRotate() {
		return fRotate;
	}

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>setAutoAccesskeys</method>
	<java>final public void setAutoAccesskeys(boolean b)</java>
	<cpp>void setAutoAccesskeys(boolean b)</cpp>
	<descr>
	<p>Makes this group allowing Auto Access Keys.</p>
	<xref>
	<chapter>Option</chapter>
	<linkend>AccessKey</linkend>
	</xref>

	</descr>
	</api>
</page>
</kaleidoc>
	*/
	void setAutoAccesskeys(boolean b) {
		fAutoAccesskeys = b;
	}

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>isAutoAccesskeys</method>
	<java>final public boolean isAutoAccesskeys()</java>
	<cpp>boolean isAutoAccesskeys()</cpp>
	<descr>
	<p>Returns if this group allows Auto Access Keys.</p>
	<xref>
	<chapter>Option</chapter>
	<linkend>AccessKey</linkend>
	</xref>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	boolean isAutoAccesskeys() {
		return fAutoAccesskeys;
	}

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>getView</method>
	<java>View getView()</java>
	<cpp>View* getView()</cpp>
	<descr>
	<p>Returns the View used by the Group to render in the display.</p>
	<p>In the C version, the ownership of the returned object is not transferred to the caller.</p>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	View* getView() {
		return fView;
	}

	void setView(View* v) {
		fView = v;
	}

	char* renderStr() ;

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>aboutToNavigate</method>
	<java>void aboutToNavigate()</java>
	<cpp>void aboutToNavigate()</cpp>
	<descr>
	<p>Called by Kaleido when the current Layout will be left and replaced by another one. This method may be overridden to add any specific behavior. When KPage::navigate() is called to navigate to another layout, KRuntime calls each activated Group's aboutToNavigate() method. The default implentation of Group::aboutToNavigate() calls its populator's aboutToNavigate() method if that populator exists.</p>
	<p>A Group plugin may override this method (eventually call super if the associated GroupPopulator.aboutTonavigate() should also be called) to get Group'code be called when the layout switches.</p>
	<note>This method is NOT called if navigation is done by using the message queue directly.</note>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	virtual void aboutToNavigate();

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>permanentActivate</method>
	<java>void setPermanentActivate()</java>
	<cpp>void setPermanentActivate()</cpp>
	<descr>
	<p>Makes the Group permanently activated. This is normally set in Kaleido Design.</p>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	void setPermanentActivate(boolean v = true) {
		fPermanentActivate = v;
	}

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>isPermanentActivate</method>
	<java>public boolean isPermanentActivate()</java>
	<cpp>virtual boolean isPermanentActivate()</cpp>
	<descr>
	<p>Returns true is the group is permanently activated. This method can be overriden to provide a calculated activation, returning true if some conditions are met.</p>
	<note>Permanent groups always handle actions AFTER the groups in the activation tree.</note>
	</descr>
	</api>
</page>
</kaleidoc>
	*/
	virtual boolean isPermanentActivate() {
		return fPermanentActivate;
	}

	void activate() {
		activate(NULL, true);
	}

	void activate(Option* activating, boolean force) ;

	virtual void activateOn() {}
	virtual void activateOff() {}

	/*
	<kaleidoc>
<filename>Group</filename>
<page>
<api>
	<class>Group</class>
	<method>resetFocusIndex</method>
	<java>void resetFocusIndex()</java>
	<cpp>void resetFocusIndex()</cpp>
	<descr>
	<p>Sets the Group's focus back to the focus found on the store or the initial focus.</p>
	</descr>
	</api>
</page>
</kaleidoc>
	*/