jdxi_editor.ui.style.dimensions =============================== .. py:module:: jdxi_editor.ui.style.dimensions .. autoapi-nested-parse:: class JDXIDimensions Class to store dimensions of a Roland JDXi instrument # Example usage: ---------------- >>> print(JDXiUIDimensions.INSTRUMENT.HEIGHT) 400 >>> print(JDXiUIDimensions.INSTRUMENT.WIDTH) 1000 Classes ------- .. autoapisummary:: jdxi_editor.ui.style.dimensions.ControlMetrics jdxi_editor.ui.style.dimensions.Margins jdxi_editor.ui.style.dimensions.Dimensions jdxi_editor.ui.style.dimensions.DigitalDimensions jdxi_editor.ui.style.dimensions.AnalogDimensions jdxi_editor.ui.style.dimensions.ComboBoxDimensions jdxi_editor.ui.style.dimensions.IconDimensions jdxi_editor.ui.style.dimensions.SmallIconDimensions jdxi_editor.ui.style.dimensions.DigitalEditorDimensions jdxi_editor.ui.style.dimensions.BasicEditorDimensions jdxi_editor.ui.style.dimensions.DrumEditorDimensions jdxi_editor.ui.style.dimensions.WaveformIconDimensions jdxi_editor.ui.style.dimensions.LfoIconDimensions jdxi_editor.ui.style.dimensions.SplashScreenDimensions jdxi_editor.ui.style.dimensions.ChartMetrics jdxi_editor.ui.style.dimensions.InstrumentDimensions jdxi_editor.ui.style.dimensions.EditorDimensions jdxi_editor.ui.style.dimensions.ArpDimensions jdxi_editor.ui.style.dimensions.AnalogEditorDimensions jdxi_editor.ui.style.dimensions.LEDDisplayDimensions jdxi_editor.ui.style.dimensions.DigitalTitleDimensions jdxi_editor.ui.style.dimensions.PWMWidgetDimensions jdxi_editor.ui.style.dimensions.TitleDimensions jdxi_editor.ui.style.dimensions.KeyboardDimensions jdxi_editor.ui.style.dimensions.SequencerGridDimensions jdxi_editor.ui.style.dimensions.SequencerContainerDimensions jdxi_editor.ui.style.dimensions.SequencerDimensions jdxi_editor.ui.style.dimensions.SliderContainerDimensions jdxi_editor.ui.style.dimensions.SliderDimensions jdxi_editor.ui.style.dimensions.PartsDimensions jdxi_editor.ui.style.dimensions.EffectsButtonDimensions jdxi_editor.ui.style.dimensions.RoundButtonDimensions jdxi_editor.ui.style.dimensions.ToneButtonDimensions jdxi_editor.ui.style.dimensions.ProgramButtonDimensions jdxi_editor.ui.style.dimensions.OctaveButtonDimensions jdxi_editor.ui.style.dimensions.MidiConfig jdxi_editor.ui.style.dimensions.SliderValueLabelDimensions jdxi_editor.ui.style.dimensions.VerticalSliderDimensions jdxi_editor.ui.style.dimensions.HorizontalSliderDimensions jdxi_editor.ui.style.dimensions.PatchManagerDimensions jdxi_editor.ui.style.dimensions.GroupBoxDimensions jdxi_editor.ui.style.dimensions.JDXiUIDimensions Module Contents --------------- .. py:class:: ControlMetrics .. py:attribute:: MIN_WIDTH :type: int :value: 20 .. py:attribute:: MIN_HEIGHT :type: int :value: 14 .. py:class:: Margins .. py:attribute:: left :type: int .. py:attribute:: top :type: int .. py:attribute:: right :type: int .. py:attribute:: bottom :type: int .. py:method:: __iter__() Make Margins iterable so it can be unpacked with *margins. .. py:class:: Dimensions Dimensions .. py:attribute:: X :type: int :value: 0 .. py:attribute:: Y :type: int :value: 0 .. py:attribute:: WIDTH :type: int :value: 0 .. py:attribute:: HEIGHT :type: int :value: 0 .. py:attribute:: MARGIN :type: int :value: 0 .. py:attribute:: SPACING :type: int :value: 0 .. py:attribute:: MIN_WIDTH :type: Optional[int] :value: None .. py:attribute:: MIN_HEIGHT :type: Optional[int] :value: None .. py:attribute:: MAX_WIDTH :type: Optional[int] :value: None .. py:attribute:: MAX_HEIGHT :type: Optional[int] :value: None .. py:attribute:: INIT_WIDTH :type: Optional[int] :value: None .. py:attribute:: INIT_HEIGHT :type: Optional[int] :value: None .. py:attribute:: MARGINS :type: tuple :value: (5, 5, 5, 5) .. py:method:: right() -> int :classmethod: .. py:method:: bottom() -> int :classmethod: .. py:class:: DigitalDimensions Bases: :py:obj:`Dimensions` Digital Dimensions .. py:attribute:: SPACING :type: int :value: 5 .. py:attribute:: MARGIN :type: int :value: 5 .. py:attribute:: MIN_CONTROL_WIDTH :type: int :value: 20 .. py:attribute:: MIN_CONTROL_HEIGHT :type: int :value: 14 .. py:attribute:: MIN_WIDTH :value: 850 .. py:attribute:: MIN_HEIGHT :type: int :value: 300 .. py:attribute:: WIDTH :type: int :value: 1030 .. py:attribute:: HEIGHT :value: 600 .. py:class:: AnalogDimensions Bases: :py:obj:`Dimensions` Analog Editor Dimensions .. py:attribute:: SPACING :type: int :value: 4 .. py:attribute:: MARGIN :type: int :value: 5 .. py:attribute:: MIN_CONTROL_WIDTH :type: int :value: 20 .. py:attribute:: MIN_CONTROL_HEIGHT :type: int :value: 14 .. py:class:: ComboBoxDimensions Bases: :py:obj:`Dimensions` Combo Box Dimensions .. py:attribute:: WIDTH :type: int :value: 425 .. py:attribute:: HEIGHT :type: int :value: 25 .. py:class:: IconDimensions Bases: :py:obj:`Dimensions` Icon Dimensions .. py:attribute:: SCALE_SMALL :type: float :value: 0.7 .. py:attribute:: WIDTH :type: int :value: 30 .. py:attribute:: HEIGHT :type: int :value: 30 .. py:class:: SmallIconDimensions Bases: :py:obj:`Dimensions` Dimensions of an Icon .. py:attribute:: WIDTH :type: int :value: 20 .. py:attribute:: HEIGHT :type: int :value: 20 .. py:class:: DigitalEditorDimensions Bases: :py:obj:`Dimensions` Digital Filter Dimensions .. py:attribute:: SPACING :type: int :value: 5 .. py:attribute:: MARGINS .. py:attribute:: MIN_WIDTH :type: Optional[int] :value: 850 .. py:attribute:: MIN_HEIGHT :type: Optional[int] :value: 300 .. py:attribute:: INIT_WIDTH :type: Optional[int] :value: 1030 .. py:attribute:: INIT_HEIGHT :type: Optional[int] :value: 600 .. py:class:: BasicEditorDimensions Bases: :py:obj:`Dimensions` Basic Editor Dimensions .. py:attribute:: IMAGE_HEIGHT :type: int :value: 150 .. py:attribute:: WIDTH :type: int :value: 550 .. py:attribute:: HEIGHT :type: int :value: 550 .. py:class:: DrumEditorDimensions Bases: :py:obj:`Dimensions` Drum Editor Dimensions .. py:attribute:: WIDTH :type: int :value: 1100 .. py:attribute:: HEIGHT :type: int :value: 800 .. py:attribute:: PARTIAL_TAB_MIN_WIDTH :value: 400 .. py:attribute:: MIN_HEIGHT :type: Optional[int] :value: 300 .. py:class:: WaveformIconDimensions Bases: :py:obj:`Dimensions` Waveform Icon Dimensions .. py:attribute:: Icon :type: SmallIconDimensions .. py:attribute:: WIDTH :type: int :value: 80 .. py:attribute:: HEIGHT :type: int :value: 30 .. py:class:: LfoIconDimensions Bases: :py:obj:`Dimensions` Lfo Icon Dimensions .. py:attribute:: WIDTH :type: int :value: 20 .. py:attribute:: HEIGHT :type: int :value: 20 .. py:class:: SplashScreenDimensions Bases: :py:obj:`Dimensions` Splash screen dimensions (matches splash_screen_540_850.png) .. py:attribute:: WIDTH :type: int :value: 850 .. py:attribute:: HEIGHT :type: int :value: 540 .. py:attribute:: IMAGE_WIDTH :type: int :value: 850 .. py:attribute:: IMAGE_HEIGHT :type: int :value: 540 .. py:class:: ChartMetrics Chart Metrics .. py:attribute:: POINT_SIZE :type: int :value: 2 .. py:class:: InstrumentDimensions Bases: :py:obj:`Dimensions` Instrument Dimensions .. py:attribute:: MARGIN :type: int :value: 15 .. py:attribute:: HEIGHT :type: int :value: 400 .. py:attribute:: WIDTH :type: int :value: 1000 .. py:class:: EditorDimensions Bases: :py:obj:`Dimensions` EditorDimensions .. py:attribute:: HEIGHT :type: int :value: 250 .. py:attribute:: MIN_HEIGHT :type: int :value: 250 .. py:attribute:: MARGINS :value: (1, 1, 1, 1) .. py:class:: ArpDimensions Bases: :py:obj:`Dimensions` ArpDimensions .. py:attribute:: MARGIN :type: int :value: 5 .. py:attribute:: SPACING :type: int :value: 20 .. py:attribute:: X :type: int :value: 120 .. py:attribute:: Y :type: int :value: 125 .. py:attribute:: WIDTH :type: int :value: 120 .. py:attribute:: HEIGHT :type: int :value: 100 .. py:class:: AnalogEditorDimensions Bases: :py:obj:`EditorDimensions` Analog Editor Dimensions .. py:attribute:: MIN_WIDTH :type: int :value: 330 .. py:attribute:: MIN_HEIGHT :type: int :value: 330 .. py:attribute:: WIDTH :type: int :value: 950 .. py:attribute:: HEIGHT :type: int :value: 600 .. py:attribute:: MARGINS :value: (1, 1, 1, 1) .. py:class:: LEDDisplayDimensions Bases: :py:obj:`Dimensions` LED digital area (enlarged for 2 rows) .. py:attribute:: WIDTH :type: int :value: 210 .. py:attribute:: HEIGHT :type: int :value: 70 .. py:attribute:: X :value: 35 .. py:attribute:: Y :value: 50 .. py:class:: DigitalTitleDimensions Bases: :py:obj:`Dimensions` Digital Title Dimensions LED title area (enlarged for 2 rows) .. py:attribute:: WIDTH :type: int :value: 330 .. py:attribute:: HEIGHT :type: int :value: 70 .. py:class:: PWMWidgetDimensions Bases: :py:obj:`Dimensions` PWM Widget Dimensions .. py:attribute:: X :type: int :value: 100 .. py:attribute:: Y :type: int :value: 100 .. py:attribute:: WIDTH :type: int :value: 300 .. py:attribute:: HEIGHT :type: int :value: 500 .. py:class:: TitleDimensions Bases: :py:obj:`Dimensions` Title above digital (moved down) .. py:attribute:: X :value: 35 .. py:attribute:: Y :value: 15 .. py:attribute:: WIDTH :type: int :value: 200 .. py:attribute:: HEIGHT :type: int :value: 50 .. py:class:: KeyboardDimensions Bases: :py:obj:`Dimensions` Keyboard Dimensions .. py:attribute:: HEIGHT :type: int :value: 127 .. py:attribute:: WIDTH :value: 800 .. py:class:: SequencerGridDimensions Bases: :py:obj:`Dimensions` Sequencer Grid Dimensions .. py:attribute:: WIDTH :type: int :value: 300 .. py:attribute:: HEIGHT :type: int :value: 30 .. py:class:: SequencerContainerDimensions Bases: :py:obj:`Dimensions` Sequencer container .. py:attribute:: X :value: 535 .. py:attribute:: Y :value: 170 .. py:attribute:: WIDTH :type: int :value: 500 .. py:attribute:: HEIGHT :type: int :value: 80 .. py:class:: SequencerDimensions Bases: :py:obj:`Dimensions` Sequencer Dimensions .. py:attribute:: STEPS :type: int :value: 16 .. py:attribute:: STEP_SIZE :type: int :value: 18 .. py:attribute:: SQUARE_SIZE :type: int :value: 25 .. py:attribute:: LARGE_SQUARE_SIZE :type: int :value: 40 .. py:attribute:: Y_WINDOWS :value: 293 .. py:attribute:: Y_NON_WINDOWS :value: 293 .. py:attribute:: WIDTH :type: int :value: 440 .. py:attribute:: X :value: 545 .. py:attribute:: GRID :type: SequencerGridDimensions .. py:attribute:: CONTAINER :type: SequencerContainerDimensions .. py:class:: SliderContainerDimensions Bases: :py:obj:`Dimensions` Slider Container Dimensions .. py:attribute:: WIDTH :type: int :value: 360 .. py:attribute:: HEIGHT :type: int :value: 140 .. py:class:: SliderDimensions Bases: :py:obj:`Dimensions` Slider Dimensions .. py:attribute:: X :type: int :value: 515 .. py:attribute:: Y :type: int :value: 15 .. py:attribute:: HEIGHT :type: int :value: 120 .. py:attribute:: CONTAINER :type: SliderContainerDimensions .. py:class:: PartsDimensions Bases: :py:obj:`Dimensions` Parts container .. py:attribute:: X :value: 255 .. py:attribute:: Y :value: 15 .. py:attribute:: WIDTH :type: int :value: 180 .. py:attribute:: HEIGHT :type: int :value: 220 .. py:class:: EffectsButtonDimensions Bases: :py:obj:`Dimensions` Effects Button Dimensions .. py:attribute:: X :value: 910 .. py:attribute:: Y :value: 15 .. py:attribute:: WIDTH :value: 80 .. py:attribute:: HEIGHT :type: int :value: 120 .. py:class:: RoundButtonDimensions Bases: :py:obj:`Dimensions` Button Dimensions .. py:attribute:: WIDTH :type: int :value: 30 .. py:attribute:: HEIGHT :type: int :value: 30 .. py:class:: ToneButtonDimensions Bases: :py:obj:`Dimensions` Tone button dimensions .. py:attribute:: X :type: int :value: 385 .. py:attribute:: Y :value: 90 .. py:attribute:: WIDTH :type: int :value: 150 .. py:attribute:: HEIGHT :value: 80 .. py:class:: ProgramButtonDimensions Bases: :py:obj:`Dimensions` Program buttons .. py:attribute:: X :type: int :value: 385 .. py:attribute:: Y :value: 30 .. py:attribute:: WIDTH :type: int :value: 150 .. py:attribute:: HEIGHT :value: 80 .. py:class:: OctaveButtonDimensions Bases: :py:obj:`Dimensions` Octave Button Dimensions .. py:attribute:: X :value: 25 .. py:attribute:: Y :type: int :value: 125 .. py:attribute:: WIDTH :type: int :value: 120 .. py:attribute:: HEIGHT :type: int :value: 100 .. py:class:: MidiConfig Bases: :py:obj:`Dimensions` Midi Config Dimensions .. py:attribute:: WIDTH :value: 300 .. py:attribute:: HEIGHT :value: 300 .. py:class:: SliderValueLabelDimensions Bases: :py:obj:`Dimensions` Slider label dimensions .. py:attribute:: MIN_WIDTH :value: 20 .. py:class:: VerticalSliderDimensions Bases: :py:obj:`Dimensions` Slider Dimensions .. py:attribute:: label .. py:attribute:: HEIGHT :value: 180 .. py:attribute:: MIN_WIDTH :value: 80 .. py:attribute:: MAX_WIDTH :value: 100 .. py:class:: HorizontalSliderDimensions Bases: :py:obj:`Dimensions` Slider Dimensions .. py:attribute:: label .. py:attribute:: HEIGHT :value: 180 .. py:attribute:: MIN_HEIGHT :value: 50 .. py:attribute:: MAX_HEIGHT :value: 60 .. py:attribute:: MIN_WIDTH :value: 80 .. py:attribute:: MAX_WIDTH :value: 100 .. py:class:: PatchManagerDimensions Bases: :py:obj:`Dimensions` Patch manager Dimensions .. py:attribute:: WIDTH :value: 400 .. py:attribute:: HEIGHT :value: 300 .. py:class:: GroupBoxDimensions Bases: :py:obj:`Dimensions` group box dimensions .. py:attribute:: MARGINS .. py:attribute:: SPACING :value: 5 .. py:class:: JDXiUIDimensions Bases: :py:obj:`Dimensions` A class to store dimensions for the JD-Xi editor UI. .. py:attribute:: group .. py:attribute:: patch .. py:attribute:: slider_vertical .. py:attribute:: slider_horizontal .. py:attribute:: Icon :type: IconDimensions .. py:attribute:: Combo :type: ComboBoxDimensions .. py:attribute:: WaveformIcon :type: WaveformIconDimensions .. py:attribute:: LFOIcon :type: LfoIconDimensions .. py:attribute:: SPLASH :type: SplashScreenDimensions .. py:attribute:: Config :type: MidiConfig .. py:attribute:: INSTRUMENT :type: InstrumentDimensions .. py:attribute:: EDITOR :type: EditorDimensions .. py:attribute:: EDITOR_DIGITAL :type: DigitalEditorDimensions .. py:attribute:: EDITOR_BASIC :type: BasicEditorDimensions .. py:attribute:: EDITOR_ANALOG :type: AnalogEditorDimensions .. py:attribute:: EDITOR_DRUM :type: DrumEditorDimensions .. py:attribute:: ANALOG .. py:attribute:: ARPEGGIATOR :type: ArpDimensions .. py:attribute:: PWM_WIDGET :type: PWMWidgetDimensions .. py:attribute:: BUTTON_ROUND :type: RoundButtonDimensions .. py:attribute:: CHART :type: ChartMetrics .. py:attribute:: LED :type: LEDDisplayDimensions .. py:attribute:: DIGITAL_TITLE :type: DigitalTitleDimensions .. py:attribute:: TITLE :type: TitleDimensions .. py:attribute:: KEYBOARD :type: KeyboardDimensions .. py:attribute:: SEQUENCER :type: SequencerDimensions .. py:attribute:: SLIDER :type: SliderDimensions .. py:attribute:: PARTS :type: PartsDimensions .. py:attribute:: OCTAVE :type: OctaveButtonDimensions .. py:attribute:: PROGRAM :type: ProgramButtonDimensions .. py:attribute:: TONE :type: ToneButtonDimensions .. py:attribute:: EFFECTS :type: EffectsButtonDimensions