kr_kpage.h

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

</kaleidoc>
*/
	 boolean isBreakAction() {
		 return fBreakAction;
	 }
	 
	 void resetBreakAction() {
		 setBreakAction(false);
	 }

/*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>setJumpLink</method>
    <java>final  public void setJumpLink(int action, String link)</java>
    <cpp>void setJumpLink(long action, char* link)</cpp>
    <descr>
    <p>This method allow to add a local jumpLink to the Layout. A Local Link overrides a Global JumpLink. An empty string "" as link nullates a jumpLink.</p>
    <p>In the C version, this method takes link's ownership.</p>
        <code>gContext->setJumpLink(Model__kAction_InCall, xstrdup("myLayout.bin"));</code>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 void setJumpLink(long action, char* link) ;
	 
	 char* getJumpLink(long action) ;

	 /*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
   <class>KPage</class>
    <method>getName</method>
    <cpp>char* getName()</cpp>
    <java>public final String getName()</java>
    <descr>
    <p>Returns the name of the KPage, defined in Kaleido Design</p>
    </descr>
     <notes></notes>
    <examples></examples>
</api>
</page>
</kaleidoc>
*/
	 char* getName() {
		 return fName;
		}

/*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>getJumpLinks</method>
    <java>SmallArrayList getJumpLinks()</java>
    <cpp>SmallArrayList* getJumpLinks()</cpp>
    <descr>
    <p>Returns an array containing the current JumpTable. The index in the table is the action associated to a JumpLink.
    A NULL entry in an element means that there is no link associated to the concerned action.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 LinksJumpMap* getJumpLinks() { 
		 return fLinksJumpTable; 
	 }

	 /*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>setOptionForAction</method>
    <java>final public Option setOptionForAction(int actionID, Option target)</java>
    <cpp>Option* setOptionForAction(long actionID, Option* target)</cpp>
    <descr>
    <p>Creates a new subscription to the action actionID in favor of the option target. A subscription is valid during the life of a Layout. When another Layout is loaded, all current subscriptions are cancelled. This method returns a reference to the last Option having subscribed to the same action. setOptionForAction does NOT get the ownership of the Option and so will not delete it.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 Option* setOptionForAction(long action, Option* o);

/*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>addOptionForAction</method>
    <java></java>
    <cpp>void addOptionForAction(long action, Option* o)</cpp>
    <descr>
    <p>This method registers the option o for the given action. If other options are already registered for this action, the new option is registered also and preceding registrations are kept. For efficiency reasons, add does NOT check if the same (action, option) association is added more than once. (cf. removeOptionForAction()) addOptionForAction does NOT get the ownership of the object and so it will not delete it.</p>
    <p>Normally, Options' ownership belongs to its Group.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 void addOptionForAction(long action, Option* o);

/*
 <kaleidoc>
<filename>KPage</filename>
<page>
<api>
     <class>KPage</class>
     <method>addOptionForAllActions</method>
     <java></java>
     <cpp>void addOptionForAllActions(Option* o)</cpp>
     <descr>
         <p>This method registers the option o for all actions</p>
     </descr>
 </api>
</page>
</kaleidoc>
*/
	 void addOptionForAllActions(Option* o);

/*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>removeOptionForAction</method>
    <java></java>
    <cpp>removeOptionForAction(long action, Option* o)</cpp>
    <descr>
    <p>Removes the first association (action, option) found from the map. If the same (key, value) association is added more than once, only one of them will be removed.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 void removeOptionForAction(long action, Option* o);

	 /*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>removeOptionForAction</method>
    <java></java>
    <cpp>removeOptionForAction(long action)</cpp>
    <descr>
    <p>Removes all options associated with the given option.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 void removeOptionForAction(long action);

	 /*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>resetOptionForActionArray</method>
    <java></java>
    <cpp>void resetOptionForActionArray()</cpp>
    <descr>
    <p>Clears the association table.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 void resetOptionForActionArray();
	 
	 void resetOptionForAccessKeyArray();

	 Group* getHandlerGroup4Action(long actionid);
	 Group* getHandlerGroup4AutoAccesskeys();
	 Option* getHandlerOption4AccessKey(long action);

	 long getActionFromOption(Option* o);
	 
	 Option* setOptionForAccessKey(long AccessKey, Option* o);
	 
	 void doStep(long step, long direction);
	 
	 SmallArrayList* getHistory() {//deprecated
			  return getAcceptHistory();
	 }
	 
/*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
   <class>KPage</class>
    <method>getAcceptHistory</method>
    <cpp>SmallArrayList* getAcceptHistory()</cpp>
    <java>final public SmallArrayList getAcceptHistory()</java>
    <descr>
    <p>Returns the accepted Options list. This direct use of an internal object is provided for non anticipated use. When possible, rather use acceptHistoryClear(), acceptHistoryPush()...</p>
    </descr>
     <notes></notes>
    <examples></examples>
</api>
</page>
</kaleidoc>
*/
	 SmallArrayList* getAcceptHistory() {
			  return fHistory;
	 }

	 /*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
   <class>KPage</class>
    <method>acceptHistoryClear</method>
    <cpp>void acceptHistoryClear()</cpp>
    <java>final public void acceptHistoryClear()</java>
    <descr>
    <p>Clears the list of accepted Options.</p>
    </descr>
     <notes></notes>
    <examples></examples>
</api>
</page>
</kaleidoc>
*/
	 void acceptHistoryClear() {
		 fHistory->clear();
		 }
	 
/*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
   <class>KPage</class>
    <method>acceptHistoryPush</method>
    <cpp>void acceptHistoryPush(Option* o)</cpp>
    <java>final public void acceptHistoryPush(Option o)</java>
    <descr>
    <p>Adds the option o to the list of accepted Options.</p>
    </descr>
     <notes></notes>
    <examples></examples>
</api>
</page>
</kaleidoc>
*/
	 void acceptHistoryPush(Option* o) {
		 Option* top = (Option*)fHistory->get(0);
		 if(top != o)
			 fHistory->push(o);
		 }
	 
/*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
   <class>KPage</class>
    <method>acceptHistoryIsMember</method>
    <cpp>boolean acceptHistoryIsMember(Option* o)</cpp>
    <java>final public boolean acceptHistoryIsMember(Option o)</java>
    <descr>
    <p>Returns true is the option o is in the accepted Options list.</p>
    </descr>
     <notes></notes>
    <examples></examples>
</api>
</page>
</kaleidoc>
*/
	 boolean acceptHistoryIsMember(Option* o) {
			return fHistory->indexOf(o) >= 0;
		 }

	 void closeAccepted();
	 
	 GContext* getContext() { 
		 return fContext; 
			}
/*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>getGroupArray</method>
    <java>SmallArrayList* getGroupArray()</java>
    <cpp>SmallArrayList* getGroupArray()</cpp>
    <descr>
    <p>Returns the list of all instantiated groups.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 SmallArrayList* getGroupArray()
			{ return fGroupArray; }

	 /*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>getRestoredFileVersion</method>
    <java></java>
    <cpp>long getRestoredFileVersion()</cpp>
    <descr>
    <p>Returns the file version of the runtime used in KD to generate the current bin file.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 long getRestoredFileVersion()
	 { return fRestoredFileVersion; }
/*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>getSaveNumber</method>
    <java></java>
    <cpp>long getSaveNumber()</cpp>
    <descr>
    <p>Returns the save number of the HMI file used to generate the current KPage. This number is the save number of the HMI file that has been used to generate the bin file.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 long getSaveNumber()
	 { return fSaveNumber; }
/*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>getModelBuildNumber</method>
    <java></java>
    <cpp>long getModelBuildNumber()</cpp>
    <descr>
    <p>Returns the model build number of the runtime used in KD to generate the current bin file.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 long getModelBuildNumber()
	 { return fModelBuildNumber; }
	 
	 /*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>getAcceptKey</method>
    <java>int getAcceptKey()</java>
    <cpp>long getAcceptKey()</cpp>
    <descr>
    <p>This method allows to get the accept key that may have been defined for this layout. This is usually done in Kaleido Design.
    If No accept key has been defined, it returns -1.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 long getAcceptKey()
	 { return fAcceptKey; }

	 /*
	 <kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>isMileStone</method>
    <java></java>
    <cpp>boolean isMileStone()</cpp>
    <descr>
    <p>This method allows to know if this layout is a milestone.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/

	 boolean isMileStone()	
	 { return fMileStone ; }

	 /*
<kaleidoc>
<filename>KPage</filename>
<page>
<api>
    <class>KPage</class>
    <method>setMileStone</method>
    <java></java>
    <cpp>void setMileStone(boolean newState)</cpp>
    <descr>
    <p>This method allows to set the "milestone" property of the page.</p>
    </descr>
</api>
</page>
</kaleidoc>
*/
	 void setMileStone(boolean newMileStone)	
	 { fMileStone=newMileStone; return ; }

	 Option* createIndicator(char* groupName, char* optionClass, 
						char* jitMapperClass, char* bgSrcOff, char* captionOff,
						int xSlot, int ySlot, int wSlot, int hSlot) ;
						
	 boolean isConsumeAction(long actionid) ;

};

#endif // ndef __KR_KPAGE__