io.qt.gui.QKeySequence Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtjambi-jre8 Show documentation
The newest version!
package io.qt.gui;


/**
 * Encapsulates a key sequence as used by shortcuts
 * Java wrapper for Qt class QKeySequence
 */
public class QKeySequence extends io.qt.QtObject
    implements java.lang.Comparable,
            java.lang.Cloneable
{
    static {
        QtJambi_LibraryUtilities.initialize();
    }
    
    /**
     * This variable stores the meta-object for the class.
     */
    public static final io.qt.core.QMetaObject staticMetaObject = io.qt.core.QMetaObject.forType(QKeySequence.class);
    
    /**
     * Java wrapper for Qt enum QKeySequence::SequenceFormat
     */
    public enum SequenceFormat implements io.qt.QtEnumerator {
        NativeText(0),
        PortableText(1);

        private SequenceFormat(int value) {
            this.value = value;
        }

        /**
         * {@inheritDoc}
         */
        public int value() {
            return value;
        }

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static SequenceFormat resolve(int value) {
            switch (value) {
            case 0: return NativeText;
            case 1: return PortableText;
            default: throw new io.qt.QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    /**
     * Java wrapper for Qt enum QKeySequence::SequenceMatch
     */
    public enum SequenceMatch implements io.qt.QtEnumerator {
        NoMatch(0),
        PartialMatch(1),
        ExactMatch(2);

        private SequenceMatch(int value) {
            this.value = value;
        }

        /**
         * {@inheritDoc}
         */
        public int value() {
            return value;
        }

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static SequenceMatch resolve(int value) {
            switch (value) {
            case 0: return NoMatch;
            case 1: return PartialMatch;
            case 2: return ExactMatch;
            default: throw new io.qt.QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    /**
     * Java wrapper for Qt enum QKeySequence::StandardKey
     */
    public enum StandardKey implements io.qt.QtEnumerator {
        UnknownKey(0),
        HelpContents(1),
        WhatsThis(2),
        Open(3),
        Close(4),
        Save(5),
        New(6),
        Delete(7),
        Cut(8),
        Copy(9),
        Paste(10),
        Undo(11),
        Redo(12),
        Back(13),
        Forward(14),
        Refresh(15),
        ZoomIn(16),
        ZoomOut(17),
        Print(18),
        AddTab(19),
        NextChild(20),
        PreviousChild(21),
        Find(22),
        FindNext(23),
        FindPrevious(24),
        Replace(25),
        SelectAll(26),
        Bold(27),
        Italic(28),
        Underline(29),
        MoveToNextChar(30),
        MoveToPreviousChar(31),
        MoveToNextWord(32),
        MoveToPreviousWord(33),
        MoveToNextLine(34),
        MoveToPreviousLine(35),
        MoveToNextPage(36),
        MoveToPreviousPage(37),
        MoveToStartOfLine(38),
        MoveToEndOfLine(39),
        MoveToStartOfBlock(40),
        MoveToEndOfBlock(41),
        MoveToStartOfDocument(42),
        MoveToEndOfDocument(43),
        SelectNextChar(44),
        SelectPreviousChar(45),
        SelectNextWord(46),
        SelectPreviousWord(47),
        SelectNextLine(48),
        SelectPreviousLine(49),
        SelectNextPage(50),
        SelectPreviousPage(51),
        SelectStartOfLine(52),
        SelectEndOfLine(53),
        SelectStartOfBlock(54),
        SelectEndOfBlock(55),
        SelectStartOfDocument(56),
        SelectEndOfDocument(57),
        DeleteStartOfWord(58),
        DeleteEndOfWord(59),
        DeleteEndOfLine(60),
        InsertParagraphSeparator(61),
        InsertLineSeparator(62),
        SaveAs(63),
        Preferences(64),
        Quit(65),
        FullScreen(66),
        Deselect(67),
        DeleteCompleteLine(68),
        Backspace(69),
        Cancel(70);

        private StandardKey(int value) {
            this.value = value;
        }

        /**
         * {@inheritDoc}
         */
        public int value() {
            return value;
        }

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static StandardKey resolve(int value) {
            switch (value) {
            case 0: return UnknownKey;
            case 1: return HelpContents;
            case 2: return WhatsThis;
            case 3: return Open;
            case 4: return Close;
            case 5: return Save;
            case 6: return New;
            case 7: return Delete;
            case 8: return Cut;
            case 9: return Copy;
            case 10: return Paste;
            case 11: return Undo;
            case 12: return Redo;
            case 13: return Back;
            case 14: return Forward;
            case 15: return Refresh;
            case 16: return ZoomIn;
            case 17: return ZoomOut;
            case 18: return Print;
            case 19: return AddTab;
            case 20: return NextChild;
            case 21: return PreviousChild;
            case 22: return Find;
            case 23: return FindNext;
            case 24: return FindPrevious;
            case 25: return Replace;
            case 26: return SelectAll;
            case 27: return Bold;
            case 28: return Italic;
            case 29: return Underline;
            case 30: return MoveToNextChar;
            case 31: return MoveToPreviousChar;
            case 32: return MoveToNextWord;
            case 33: return MoveToPreviousWord;
            case 34: return MoveToNextLine;
            case 35: return MoveToPreviousLine;
            case 36: return MoveToNextPage;
            case 37: return MoveToPreviousPage;
            case 38: return MoveToStartOfLine;
            case 39: return MoveToEndOfLine;
            case 40: return MoveToStartOfBlock;
            case 41: return MoveToEndOfBlock;
            case 42: return MoveToStartOfDocument;
            case 43: return MoveToEndOfDocument;
            case 44: return SelectNextChar;
            case 45: return SelectPreviousChar;
            case 46: return SelectNextWord;
            case 47: return SelectPreviousWord;
            case 48: return SelectNextLine;
            case 49: return SelectPreviousLine;
            case 50: return SelectNextPage;
            case 51: return SelectPreviousPage;
            case 52: return SelectStartOfLine;
            case 53: return SelectEndOfLine;
            case 54: return SelectStartOfBlock;
            case 55: return SelectEndOfBlock;
            case 56: return SelectStartOfDocument;
            case 57: return SelectEndOfDocument;
            case 58: return DeleteStartOfWord;
            case 59: return DeleteEndOfWord;
            case 60: return DeleteEndOfLine;
            case 61: return InsertParagraphSeparator;
            case 62: return InsertLineSeparator;
            case 63: return SaveAs;
            case 64: return Preferences;
            case 65: return Quit;
            case 66: return FullScreen;
            case 67: return Deselect;
            case 68: return DeleteCompleteLine;
            case 69: return Backspace;
            case 70: return Cancel;
            default: throw new io.qt.QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    
    /**
     * See QKeySequence::QKeySequence()
     */
    public QKeySequence(){
        super((QPrivateConstructor)null);
        initialize_native(this);
    }
    
    private native static void initialize_native(QKeySequence instance);
    
    /**
     * Overloaded constructor for {@link #QKeySequence(io.qt.gui.QKeyCombination, io.qt.gui.QKeyCombination, io.qt.gui.QKeyCombination, io.qt.gui.QKeyCombination)}
     *  with k4 = io.qt.gui.QKeyCombination.fromCombined(0).
     */
    public QKeySequence(io.qt.gui.QKeyCombination k1, io.qt.gui.QKeyCombination k2, io.qt.gui.QKeyCombination k3) {
        this(k1, k2, k3, io.qt.gui.QKeyCombination.fromCombined(0));
    }
    
    /**
     * Overloaded constructor for {@link #QKeySequence(io.qt.gui.QKeyCombination, io.qt.gui.QKeyCombination, io.qt.gui.QKeyCombination, io.qt.gui.QKeyCombination)}
     * with: 

     * k3 = io.qt.gui.QKeyCombination.fromCombined(0)
     * k4 = io.qt.gui.QKeyCombination.fromCombined(0)
     * 
     */
    public QKeySequence(io.qt.gui.QKeyCombination k1, io.qt.gui.QKeyCombination k2) {
        this(k1, k2, io.qt.gui.QKeyCombination.fromCombined(0), io.qt.gui.QKeyCombination.fromCombined(0));
    }
    
    /**
     * Overloaded constructor for {@link #QKeySequence(io.qt.gui.QKeyCombination, io.qt.gui.QKeyCombination, io.qt.gui.QKeyCombination, io.qt.gui.QKeyCombination)}
     * with: 

     * k2 = io.qt.gui.QKeyCombination.fromCombined(0)
     * k3 = io.qt.gui.QKeyCombination.fromCombined(0)
     * k4 = io.qt.gui.QKeyCombination.fromCombined(0)
     * 
     */
    public QKeySequence(io.qt.gui.QKeyCombination k1) {
        this(k1, io.qt.gui.QKeyCombination.fromCombined(0), io.qt.gui.QKeyCombination.fromCombined(0), io.qt.gui.QKeyCombination.fromCombined(0));
    }
    
    /**
     * See QKeySequence::QKeySequence(QKeyCombination,QKeyCombination,QKeyCombination,QKeyCombination)
     */
    public QKeySequence(io.qt.gui.QKeyCombination k1, io.qt.gui.QKeyCombination k2, io.qt.gui.QKeyCombination k3, io.qt.gui.QKeyCombination k4){
        super((QPrivateConstructor)null);
        initialize_native(this, k1, k2, k3, k4);
    }
    
    private native static void initialize_native(QKeySequence instance, io.qt.gui.QKeyCombination k1, io.qt.gui.QKeyCombination k2, io.qt.gui.QKeyCombination k3, io.qt.gui.QKeyCombination k4);
    
    /**
     * See QKeySequence::QKeySequence(QKeySequence::StandardKey)
     */
    public QKeySequence(io.qt.gui.QKeySequence.StandardKey key){
        super((QPrivateConstructor)null);
        initialize_native(this, key);
    }
    
    private native static void initialize_native(QKeySequence instance, io.qt.gui.QKeySequence.StandardKey key);
    
    /**
     * See QKeySequence::QKeySequence(QKeySequence)
     */
    public QKeySequence(io.qt.gui.QKeySequence ks){
        super((QPrivateConstructor)null);
        initialize_native(this, ks);
    }
    
    private native static void initialize_native(QKeySequence instance, io.qt.gui.QKeySequence ks);
    
    /**
     * Overloaded constructor for {@link #QKeySequence(java.lang.String, io.qt.gui.QKeySequence.SequenceFormat)}
     *  with format = io.qt.gui.QKeySequence.SequenceFormat.NativeText.
     */
    public QKeySequence(java.lang.String key) {
        this(key, io.qt.gui.QKeySequence.SequenceFormat.NativeText);
    }
    
    /**
     * See QKeySequence::QKeySequence(QString,QKeySequence::SequenceFormat)
     */
    public QKeySequence(java.lang.String key, io.qt.gui.QKeySequence.SequenceFormat format){
        super((QPrivateConstructor)null);
        initialize_native(this, key, format);
    }
    
    private native static void initialize_native(QKeySequence instance, java.lang.String key, io.qt.gui.QKeySequence.SequenceFormat format);
    
    /**
     * Overloaded constructor for {@link #QKeySequence(int, int, int, int)}
     *  with k4 = 0.
     */
    public QKeySequence(int k1, int k2, int k3) {
        this(k1, k2, k3, (int)0);
    }
    
    /**
     * Overloaded constructor for {@link #QKeySequence(int, int, int, int)}
     * with: 

     * k3 = 0
     * k4 = 0
     * 
     */
    public QKeySequence(int k1, int k2) {
        this(k1, k2, (int)0, (int)0);
    }
    
    /**
     * Overloaded constructor for {@link #QKeySequence(int, int, int, int)}
     * with: 

     * k2 = 0
     * k3 = 0
     * k4 = 0
     * 
     */
    public QKeySequence(int k1) {
        this(k1, (int)0, (int)0, (int)0);
    }
    
    /**
     * See QKeySequence::QKeySequence(int,int,int,int)
     */
    public QKeySequence(int k1, int k2, int k3, int k4){
        super((QPrivateConstructor)null);
        initialize_native(this, k1, k2, k3, k4);
    }
    
    private native static void initialize_native(QKeySequence instance, int k1, int k2, int k3, int k4);
    
    /**
     * See QKeySequence::count()const
     */
    @io.qt.QtUninvokable
    public final int count(){
        return count_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @io.qt.QtUninvokable
    private native int count_native_constfct(long __this__nativeId);
    
    @io.qt.QtUninvokable
    public final boolean isDetached(){
        return isDetached_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @io.qt.QtUninvokable
    private native boolean isDetached_native_constfct(long __this__nativeId);
    
    /**
     * See QKeySequence::isEmpty()const
     */
    @io.qt.QtUninvokable
    public final boolean isEmpty(){
        return isEmpty_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @io.qt.QtUninvokable
    private native boolean isEmpty_native_constfct(long __this__nativeId);
    
    /**
     * See QKeySequence::matches(QKeySequence)const
     */
    @io.qt.QtUninvokable
    public final io.qt.gui.QKeySequence.SequenceMatch matches(io.qt.gui.QKeySequence seq){
        return io.qt.gui.QKeySequence.SequenceMatch.resolve(matches_native_cref_QKeySequence_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(seq)));
    }
    
    @io.qt.QtUninvokable
    private native int matches_native_cref_QKeySequence_constfct(long __this__nativeId, long seq);
    
    /**
     * See QKeySequence::operator<(QKeySequence)const
     */
    @io.qt.QtUninvokable
    private final boolean operator_less(io.qt.gui.QKeySequence ks){
        return operator_less_native_cref_QKeySequence_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(ks));
    }
    
    @io.qt.QtUninvokable
    private native boolean operator_less_native_cref_QKeySequence_constfct(long __this__nativeId, long ks);
    
    @io.qt.QtUninvokable
    public void writeTo(io.qt.core.QDataStream in){
        java.util.Objects.requireNonNull(in, "Argument 'in': null not expected.");
        writeTo_native_ref_QDataStream(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(in));
    }
    
    @io.qt.QtUninvokable
    private native void writeTo_native_ref_QDataStream(long __this__nativeId, long in);
    
    /**
     * See QKeySequence::operator==(QKeySequence)const
     */
    @io.qt.QtUninvokable
    private final boolean operator_equal(io.qt.gui.QKeySequence other){
        return operator_equal_native_cref_QKeySequence_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(other));
    }
    
    @io.qt.QtUninvokable
    private native boolean operator_equal_native_cref_QKeySequence_constfct(long __this__nativeId, long other);
    
    @io.qt.QtUninvokable
    public void readFrom(io.qt.core.QDataStream out){
        java.util.Objects.requireNonNull(out, "Argument 'out': null not expected.");
        readFrom_native_ref_QDataStream(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(out));
    }
    
    @io.qt.QtUninvokable
    private native void readFrom_native_ref_QDataStream(long __this__nativeId, long out);
    
    /**
     * See QKeySequence::operator[](uint)const
     */
    @io.qt.QtUninvokable
    private final io.qt.gui.QKeyCombination operator_subscript(int i){
        return operator_subscript_native_uint_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), i);
    }
    
    @io.qt.QtUninvokable
    private native io.qt.gui.QKeyCombination operator_subscript_native_uint_constfct(long __this__nativeId, int i);
    
    /**
     * See QKeySequence::swap(QKeySequence&)
     */
    @io.qt.QtUninvokable
    public final void swap(io.qt.gui.QKeySequence other){
        java.util.Objects.requireNonNull(other, "Argument 'other': null not expected.");
        swap_native_ref_QKeySequence(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(other));
    }
    
    @io.qt.QtUninvokable
    private native void swap_native_ref_QKeySequence(long __this__nativeId, long other);
    
    /**
     * Overloaded function for {@link #toString(io.qt.gui.QKeySequence.SequenceFormat)}
     *  with format = io.qt.gui.QKeySequence.SequenceFormat.PortableText.
     */
    @io.qt.QtUninvokable
    public final java.lang.String toString() {
        return toString(io.qt.gui.QKeySequence.SequenceFormat.PortableText);
    }
    
    /**
     * See QKeySequence::toString(QKeySequence::SequenceFormat)const
     */
    @io.qt.QtUninvokable
    public final java.lang.String toString(io.qt.gui.QKeySequence.SequenceFormat format){
        return toString_native_QKeySequence_SequenceFormat_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), format.value());
    }
    
    @io.qt.QtUninvokable
    private native java.lang.String toString_native_QKeySequence_SequenceFormat_constfct(long __this__nativeId, int format);
    
    /**
     * Overloaded function for {@link #fromString(java.lang.String, io.qt.gui.QKeySequence.SequenceFormat)}
     *  with format = io.qt.gui.QKeySequence.SequenceFormat.PortableText.
     */
    public static io.qt.gui.QKeySequence fromString(java.lang.String str) {
        return fromString(str, io.qt.gui.QKeySequence.SequenceFormat.PortableText);
    }
    
    /**
     * See QKeySequence::fromString(QString,QKeySequence::SequenceFormat)
     */
    public static io.qt.gui.QKeySequence fromString(java.lang.String str, io.qt.gui.QKeySequence.SequenceFormat format){
        return fromString_native_cref_QString_QKeySequence_SequenceFormat(str, format.value());
    }
    
    private native static io.qt.gui.QKeySequence fromString_native_cref_QString_QKeySequence_SequenceFormat(java.lang.String str, int format);
    
    /**
     * See QKeySequence::keyBindings(QKeySequence::StandardKey)
     */
    public static io.qt.core.QList keyBindings(io.qt.gui.QKeySequence.StandardKey key){
        return keyBindings_native_QKeySequence_StandardKey(key.value());
    }
    
    private native static io.qt.core.QList keyBindings_native_QKeySequence_StandardKey(int key);
    
    /**
     * Overloaded function for {@link #listFromString(java.lang.String, io.qt.gui.QKeySequence.SequenceFormat)}
     *  with format = io.qt.gui.QKeySequence.SequenceFormat.PortableText.
     */
    public static io.qt.core.QList listFromString(java.lang.String str) {
        return listFromString(str, io.qt.gui.QKeySequence.SequenceFormat.PortableText);
    }
    
    /**
     * See QKeySequence::listFromString(QString,QKeySequence::SequenceFormat)
     */
    public static io.qt.core.QList listFromString(java.lang.String str, io.qt.gui.QKeySequence.SequenceFormat format){
        return listFromString_native_cref_QString_QKeySequence_SequenceFormat(str, format.value());
    }
    
    private native static io.qt.core.QList listFromString_native_cref_QString_QKeySequence_SequenceFormat(java.lang.String str, int format);
    
    /**
     * Overloaded function for {@link #listToString(java.util.Collection, io.qt.gui.QKeySequence.SequenceFormat)}
     *  with format = io.qt.gui.QKeySequence.SequenceFormat.PortableText.
     */
    public static java.lang.String listToString(java.util.Collection list) {
        return listToString(list, io.qt.gui.QKeySequence.SequenceFormat.PortableText);
    }
    
    /**
     * See QKeySequence::listToString(QList<QKeySequence>,QKeySequence::SequenceFormat)
     */
    public static java.lang.String listToString(java.util.Collection list, io.qt.gui.QKeySequence.SequenceFormat format){
        return listToString_native_cref_QList_QKeySequence_SequenceFormat(list, format.value());
    }
    
    private native static java.lang.String listToString_native_cref_QList_QKeySequence_SequenceFormat(java.util.Collection list, int format);
    
    /**
     * See QKeySequence::mnemonic(QString)
     */
    public native static io.qt.gui.QKeySequence mnemonic(java.lang.String text);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     */
    @io.qt.NativeAccess
    protected QKeySequence(QPrivateConstructor p) { super(p); } 
    

    @Override
    @io.qt.QtUninvokable
    public boolean equals(Object other) {
        if (other instanceof io.qt.gui.QKeySequence) {
            return operator_equal((io.qt.gui.QKeySequence) other);
        }

        return false;
    }

    @io.qt.QtUninvokable
    public int compareTo(io.qt.gui.QKeySequence other) {
        if (equals(other)) return 0;
        else if (operator_less(other)) return -1;
        else return 1;
    }


    @io.qt.QtUninvokable
    @Override
    public int hashCode() {
        return hashCode_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    @io.qt.QtUninvokable
    private native static int hashCode_native(long __this_nativeId);
    @io.qt.QtUninvokable
    public final QKeyCombination at(int i) {
        return operator_subscript(i);
    }
    
    @Override
    public QKeySequence clone() {
        return clone_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    private native QKeySequence clone_native(long __this_nativeId);
}