blob: 14d5e9d99770ed3b0d0f6ccf8cfba554b2a0204e [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2009, 2019 Xored Software Inc and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* Contributors:
* Xored Software Inc - initial API and implementation and/or initial documentation
*******************************************************************************/
package org.eclipse.rcptt.tesla.core.protocol.raw;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EObject;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Event</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getWidget <em>Widget</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getType <em>Type</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getDetail <em>Detail</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getItem <em>Item</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getIndex <em>Index</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getX <em>X</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getY <em>Y</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getWidth <em>Width</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getHeight <em>Height</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getCount <em>Count</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getTime <em>Time</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getButton <em>Button</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getCharacter <em>Character</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getKeyCode <em>Key Code</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getStateMask <em>State Mask</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getStart <em>Start</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getEnd <em>End</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getText <em>Text</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getData <em>Data</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#isNativeEvent <em>Native Event</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent()
* @model
* @generated
*/
public interface RawEvent extends EObject {
/**
* Returns the value of the '<em><b>Widget</b></em>' attribute list.
* The list contents are of type {@link java.lang.String}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Widget</em>' attribute list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Widget</em>' attribute list.
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Widget()
* @model unique="false"
* @generated
*/
EList<String> getWidget();
/**
* Returns the value of the '<em><b>Type</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Type</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Type</em>' attribute.
* @see #setType(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Type()
* @model
* @generated
*/
int getType();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getType <em>Type</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Type</em>' attribute.
* @see #getType()
* @generated
*/
void setType(int value);
/**
* Returns the value of the '<em><b>Detail</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Detail</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Detail</em>' attribute.
* @see #setDetail(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Detail()
* @model
* @generated
*/
int getDetail();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getDetail <em>Detail</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Detail</em>' attribute.
* @see #getDetail()
* @generated
*/
void setDetail(int value);
/**
* Returns the value of the '<em><b>Item</b></em>' attribute list.
* The list contents are of type {@link java.lang.String}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Item</em>' attribute list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Item</em>' attribute list.
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Item()
* @model unique="false"
* @generated
*/
EList<String> getItem();
/**
* Returns the value of the '<em><b>Index</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Index</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Index</em>' attribute.
* @see #setIndex(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Index()
* @model
* @generated
*/
int getIndex();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getIndex <em>Index</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Index</em>' attribute.
* @see #getIndex()
* @generated
*/
void setIndex(int value);
/**
* Returns the value of the '<em><b>X</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>X</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>X</em>' attribute.
* @see #setX(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_X()
* @model
* @generated
*/
int getX();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getX <em>X</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>X</em>' attribute.
* @see #getX()
* @generated
*/
void setX(int value);
/**
* Returns the value of the '<em><b>Y</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Y</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Y</em>' attribute.
* @see #setY(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Y()
* @model
* @generated
*/
int getY();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getY <em>Y</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Y</em>' attribute.
* @see #getY()
* @generated
*/
void setY(int value);
/**
* Returns the value of the '<em><b>Width</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Width</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Width</em>' attribute.
* @see #setWidth(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Width()
* @model
* @generated
*/
int getWidth();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getWidth <em>Width</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Width</em>' attribute.
* @see #getWidth()
* @generated
*/
void setWidth(int value);
/**
* Returns the value of the '<em><b>Height</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Height</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Height</em>' attribute.
* @see #setHeight(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Height()
* @model
* @generated
*/
int getHeight();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getHeight <em>Height</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Height</em>' attribute.
* @see #getHeight()
* @generated
*/
void setHeight(int value);
/**
* Returns the value of the '<em><b>Count</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Count</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Count</em>' attribute.
* @see #setCount(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Count()
* @model
* @generated
*/
int getCount();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getCount <em>Count</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Count</em>' attribute.
* @see #getCount()
* @generated
*/
void setCount(int value);
/**
* Returns the value of the '<em><b>Time</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Time</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Time</em>' attribute.
* @see #setTime(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Time()
* @model
* @generated
*/
int getTime();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getTime <em>Time</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Time</em>' attribute.
* @see #getTime()
* @generated
*/
void setTime(int value);
/**
* Returns the value of the '<em><b>Button</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Button</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Button</em>' attribute.
* @see #setButton(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Button()
* @model
* @generated
*/
int getButton();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getButton <em>Button</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Button</em>' attribute.
* @see #getButton()
* @generated
*/
void setButton(int value);
/**
* Returns the value of the '<em><b>Character</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Character</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Character</em>' attribute.
* @see #setCharacter(char)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Character()
* @model
* @generated
*/
char getCharacter();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getCharacter <em>Character</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Character</em>' attribute.
* @see #getCharacter()
* @generated
*/
void setCharacter(char value);
/**
* Returns the value of the '<em><b>Key Code</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Key Code</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Key Code</em>' attribute.
* @see #setKeyCode(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_KeyCode()
* @model
* @generated
*/
int getKeyCode();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getKeyCode <em>Key Code</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Key Code</em>' attribute.
* @see #getKeyCode()
* @generated
*/
void setKeyCode(int value);
/**
* Returns the value of the '<em><b>State Mask</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>State Mask</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>State Mask</em>' attribute.
* @see #setStateMask(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_StateMask()
* @model
* @generated
*/
int getStateMask();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getStateMask <em>State Mask</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>State Mask</em>' attribute.
* @see #getStateMask()
* @generated
*/
void setStateMask(int value);
/**
* Returns the value of the '<em><b>Start</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Start</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Start</em>' attribute.
* @see #setStart(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Start()
* @model
* @generated
*/
int getStart();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getStart <em>Start</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Start</em>' attribute.
* @see #getStart()
* @generated
*/
void setStart(int value);
/**
* Returns the value of the '<em><b>End</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>End</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>End</em>' attribute.
* @see #setEnd(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_End()
* @model
* @generated
*/
int getEnd();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getEnd <em>End</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>End</em>' attribute.
* @see #getEnd()
* @generated
*/
void setEnd(int value);
/**
* Returns the value of the '<em><b>Text</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Text</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Text</em>' attribute.
* @see #setText(String)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Text()
* @model
* @generated
*/
String getText();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getText <em>Text</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Text</em>' attribute.
* @see #getText()
* @generated
*/
void setText(String value);
/**
* Returns the value of the '<em><b>Data</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Data</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Data</em>' attribute.
* @see #setData(String)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_Data()
* @model
* @generated
*/
String getData();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#getData <em>Data</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Data</em>' attribute.
* @see #getData()
* @generated
*/
void setData(String value);
/**
* Returns the value of the '<em><b>Native Event</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Native Event</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Native Event</em>' attribute.
* @see #setNativeEvent(boolean)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getRawEvent_NativeEvent()
* @model
* @generated
*/
boolean isNativeEvent();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent#isNativeEvent <em>Native Event</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Native Event</em>' attribute.
* @see #isNativeEvent()
* @generated
*/
void setNativeEvent(boolean value);
} // RawEvent